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"
}
この記事は役に立ちましたか?