Model
- 인쇄
- PDF
Model
- 인쇄
- PDF
Article Summary
Share feedback
Thanks for sharing your feedback!
모델 추가
URL
POST https://apigateway.apigw.ntruss.com/api/v1/products/{product-id}/apis/{api-id}/models
요청 파라미터
| 이름 | 위치 | 필수여부 | 타입 | 설명 |
|---|---|---|---|---|
| productId | path | Y | String | Product Id 길이(최대/최소): 0/10 |
| apiId | path | Y | String | Api Id 길이(최대/최소): 0/10 |
요청 바디
{
"modelDescription" : "modelDescription",
"modelName" : "modelName",
"modelSchema" : "modelSchema"
}
응답 코드
- 201
응답 바디
{
"modelDescription" : "modelDescription",
"modelName" : "modelName",
"modelId" : "modelId",
"modelSchema" : "modelSchema",
"apiId" : "apiId"
}
모델 삭제
URL
DELETE https://apigateway.apigw.ntruss.com/api/v1/products/{product-id}/apis/{api-id}/models/{model-id}
요청 파라미터
| 이름 | 위치 | 필수여부 | 타입 | 설명 |
|---|---|---|---|---|
| productId | path | Y | String | Product Id 길이(최대/최소): 0/10 |
| apiId | path | Y | String | Api Id 길이(최대/최소): 0/10 |
| modelId | path | Y | String | Model Id 길이(최대/최소): 0/10 |
요청 바디
- 없음
응답 코드
- 204
응답 바디
- 없음
모델 조회
URL
GET https://apigateway.apigw.ntruss.com/api/v1/products/{product-id}/apis/{api-id}/models/{model-id}
요청 파라미터
| 이름 | 위치 | 필수여부 | 타입 | 설명 |
|---|---|---|---|---|
| productId | path | Y | String | Product Id 길이(최대/최소): 0/10 |
| apiId | path | Y | String | Api Id 길이(최대/최소): 0/10 |
| modelId | path | Y | String | Model Id 길이(최대/최소): 0/10 |
요청 바디
- 없음
응답 코드
- 200
응답 바디
{
"modelDescription" : "modelDescription",
"modelName" : "modelName",
"modelId" : "modelId",
"modelSchema" : "modelSchema",
"apiId" : "apiId"
}
모델 조회
URL
GET https://apigateway.apigw.ntruss.com/api/v1/products/{product-id}/apis/{api-id}/models
요청 파라미터
| 이름 | 위치 | 필수여부 | 타입 | 설명 |
|---|---|---|---|---|
| productId | path | Y | String | Product Id 길이(최대/최소): 0/10 |
| apiId | path | Y | String | Api Id 길이(최대/최소): 0/10 |
| offset | query string | N | Long | Offset 최소: 0 최대: 9,223,372,036,854,775,807 |
| limit | query string | N | Long | Limit 최소: 1 최대: 9,223,372,036,854,775,807 |
| modelName | query string | N | String | Model Name 길이(최대/최소): 0/100 |
요청 바디
- 없음
응답 코드
- 200
응답 바디
{
"productPage" : {
"total" : 0,
"content" : [ {
"modelDescription" : "modelDescription",
"modelName" : "modelName",
"modelId" : "modelId",
"modelSchema" : "modelSchema",
"apiId" : "apiId"
} ]
}
}
모델 미리보기
URL
POST https://apigateway.apigw.ntruss.com/api/v1/products/{product-id}/apis/{api-id}/models/preview
요청 파라미터
| 이름 | 위치 | 필수여부 | 타입 | 설명 |
|---|---|---|---|---|
| productId | path | Y | String | Product Id 길이(최대/최소): 0/10 |
| apiId | path | Y | String | Api Id 길이(최대/최소): 0/10 |
요청 바디
{
"modelId" : "modelId",
"modelSchema" : "modelSchema"
}
응답 코드
- 200
응답 바디
{
"modelSchema" : "{}"
}
모델 수정
URL
PUT https://apigateway.apigw.ntruss.com/api/v1/products/{product-id}/apis/{api-id}/models/{model-id}
요청 파라미터
| 이름 | 위치 | 필수여부 | 타입 | 설명 |
|---|---|---|---|---|
| productId | path | Y | String | Product Id 길이(최대/최소): 0/10 |
| apiId | path | Y | String | Api Id 길이(최대/최소): 0/10 |
| modelId | path | Y | String | Model Id 길이(최대/최소): 0/10 |
요청 바디
{
"modelDescription" : "modelDescription",
"modelSchema" : "modelSchema"
}
응답 코드
- 200
응답 바디
{
"modelDescription" : "modelDescription",
"modelName" : "modelName",
"modelId" : "modelId",
"modelSchema" : "modelSchema",
"apiId" : "apiId"
}
이 문서가 도움이 되었습니까?