Model
- Print
- PDF
Model
- Print
- PDF
Article Summary
Share feedback
Thanks for sharing your feedback!
Add a model
URL
POST https://apigateway.apigw.ntruss.com/api/v1/products/{product-id}/apis/{api-id}/models
Request Parameter
Name | Position | Required | Type | Description |
---|---|---|---|---|
productId | path | Y | String | Product Id Length(Min/Max): 0/10 |
apiId | path | Y | String | Api Id Length(Min/Max): 0/10 |
Request Body
{
"modelDescription" : "modelDescription",
"modelName" : "modelName",
"modelSchema" : "modelSchema"
}
Response Code
- 201
Response Body
{
"modelDescription" : "modelDescription",
"modelName" : "modelName",
"modelId" : "modelId",
"modelSchema" : "modelSchema",
"apiId" : "apiId"
}
Delete a model
URL
DELETE https://apigateway.apigw.ntruss.com/api/v1/products/{product-id}/apis/{api-id}/models/{model-id}
Request Parameter
Name | Position | Required | Type | Description |
---|---|---|---|---|
productId | path | Y | String | Product Id Length(Min/Max): 0/10 |
apiId | path | Y | String | Api Id Length(Min/Max): 0/10 |
modelId | path | Y | String | Model Id Length(Min/Max): 0/10 |
Request Body
- None
Response Code
- 204
Response Body
- None
Get a model
URL
GET https://apigateway.apigw.ntruss.com/api/v1/products/{product-id}/apis/{api-id}/models/{model-id}
Request Parameter
Name | Position | Required | Type | Description |
---|---|---|---|---|
productId | path | Y | String | Product Id Length(Min/Max): 0/10 |
apiId | path | Y | String | Api Id Length(Min/Max): 0/10 |
modelId | path | Y | String | Model Id Length(Min/Max): 0/10 |
Request Body
- None
Response Code
- 200
Response Body
{
"modelDescription" : "modelDescription",
"modelName" : "modelName",
"modelId" : "modelId",
"modelSchema" : "modelSchema",
"apiId" : "apiId"
}
Get Models by Api
URL
GET https://apigateway.apigw.ntruss.com/api/v1/products/{product-id}/apis/{api-id}/models
Request Parameter
Name | Position | Required | Type | Description |
---|---|---|---|---|
productId | path | Y | String | Product Id Length(Min/Max): 0/10 |
apiId | path | Y | String | Api Id Length(Min/Max): 0/10 |
offset | query string | N | Long | Offset Min: 0 Max: 9,223,372,036,854,775,807 |
limit | query string | N | Long | Limit Min: 1 Max: 9,223,372,036,854,775,807 |
modelName | query string | N | String | Model Name Length(Min/Max): 0/100 |
Request Body
- None
Response Code
- 200
Response Body
{
"productPage" : {
"total" : 0,
"content" : [ {
"modelDescription" : "modelDescription",
"modelName" : "modelName",
"modelId" : "modelId",
"modelSchema" : "modelSchema",
"apiId" : "apiId"
} ]
}
}
Preview a model
URL
POST https://apigateway.apigw.ntruss.com/api/v1/products/{product-id}/apis/{api-id}/models/preview
Request Parameter
Name | Position | Required | Type | Description |
---|---|---|---|---|
productId | path | Y | String | Product Id Length(Min/Max): 0/10 |
apiId | path | Y | String | Api Id Length(Min/Max): 0/10 |
Request Body
{
"modelId" : "modelId",
"modelSchema" : "modelSchema"
}
Response Code
- 200
Response Body
{
"modelSchema" : "{}"
}
Update a model
URL
PUT https://apigateway.apigw.ntruss.com/api/v1/products/{product-id}/apis/{api-id}/models/{model-id}
Request Parameter
Name | Position | Required | Type | Description |
---|---|---|---|---|
productId | path | Y | String | Product Id Length(Min/Max): 0/10 |
apiId | path | Y | String | Api Id Length(Min/Max): 0/10 |
modelId | path | Y | String | Model Id Length(Min/Max): 0/10 |
Request Body
{
"modelDescription" : "modelDescription",
"modelSchema" : "modelSchema"
}
Response Code
- 200
Response Body
{
"modelDescription" : "modelDescription",
"modelName" : "modelName",
"modelId" : "modelId",
"modelSchema" : "modelSchema",
"apiId" : "apiId"
}
Was this article helpful?