Method Response
- 印刷する
- PDF
Method Response
- 印刷する
- 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}/resources/{resource-id}/methods/{method-name}/responses
リクエストパラメータ
| 名前 | 位置 | 必須かどうか | タイプ | 説明 |
|---|---|---|---|---|
| productId | path | Y | String | Product Id 長さ（最大/最小）：0 / 10 |
| apiId | path | Y | String | Api Id 長さ（最大/最小）：0 / 10 |
| resourceId | path | Y | String | Resource Id 長さ（最大/最小）：0 / 10 |
| methodName | path | Y | String | Method Code 許容値：ANY, GET, POST, PUT, DELETE, PATCH, OPTIONS, HEAD |
リクエストボディ
{
"responseDescription" : "responseDescription",
"statusCode" : 0
}
応答コード
- 201
応答ボディ
{
"methodResponseDto" : {
"resourceId" : "resourceId",
"responseDescription" : "responseDescription",
"modifier" : "modifier",
"tenantId" : "tenantId",
"apiId" : "apiId",
"methodCode" : "methodCode",
"statusCode" : 0
}
}
メソッドの応答を削除
URL
DELETE https://apigateway.apigw.ntruss.com/api/v1/products/{product-id}/apis/{api-id}/resources/{resource-id}/methods/{method-name}/responses/{status-code}
リクエストパラメータ
| 名前 | 位置 | 必須かどうか | タイプ | 説明 |
|---|---|---|---|---|
| productId | path | Y | String | Product Id 長さ（最大/最小）：0 / 10 |
| apiId | path | Y | String | Api Id 長さ（最大/最小）：0 / 10 |
| resourceId | path | Y | String | Resource Id 長さ（最大/最小）：0 / 10 |
| methodName | path | Y | String | Method Code 許容値：ANY, GET, POST, PUT, DELETE, PATCH, OPTIONS, HEAD |
| statusCode | path | Y | Integer | Status Code |
リクエストボディ
- なし
応答コード
- 204
応答ボディ
- なし
メソッドの応答照会
URL
GET https://apigateway.apigw.ntruss.com/api/v1/products/{product-id}/apis/{api-id}/resources/{resource-id}/methods/{method-name}/responses
リクエストパラメータ
| 名前 | 位置 | 必須かどうか | タイプ | 説明 |
|---|---|---|---|---|
| productId | path | Y | String | Product Id 長さ（最大/最小）：0 / 10 |
| apiId | path | Y | String | Api Id 長さ（最大/最小）：0 / 10 |
| resourceId | path | Y | String | Resource Id 長さ（最大/最小）：0 / 10 |
| methodName | path | Y | String | Method Code 許容値：ANY, GET, POST, PUT, DELETE, PATCH, OPTIONS, HEAD |
リクエストボディ
- なし
応答コード
- 200
応答ボディ
{
"responses" : [ {
"resourceId" : "resourceId",
"responseDescription" : "responseDescription",
"modifier" : "modifier",
"tenantId" : "tenantId",
"apiId" : "apiId",
"methodCode" : "methodCode",
"statusCode" : 0
} ]
}
メソッドの応答の説明を修正
URL
PATCH https://apigateway.apigw.ntruss.com/api/v1/products/{product-id}/apis/{api-id}/resources/{resource-id}/methods/{method-name}/responses/{status-code}
リクエストパラメータ
| 名前 | 位置 | 必須かどうか | タイプ | 説明 |
|---|---|---|---|---|
| productId | path | Y | String | Product Id 長さ（最大/最小）：0 / 10 |
| apiId | path | Y | String | Api Id 長さ（最大/最小）：0 / 10 |
| resourceId | path | Y | String | Resource Id 長さ（最大/最小）：0 / 10 |
| methodName | path | Y | String | Method Code 許容値：ANY, GET, POST, PUT, DELETE, PATCH, OPTIONS, HEAD |
| statusCode | path | Y | Integer | Status Code |
リクエストボディ
{
"responseDescription" : "responseDescription"
}
応答コード
- 200
応答ボディ
{
"methodResponseDto" : {
"resourceId" : "resourceId",
"responseDescription" : "responseDescription",
"modifier" : "modifier",
"tenantId" : "tenantId",
"apiId" : "apiId",
"methodCode" : "methodCode",
"statusCode" : 0
}
}
この記事は役に立ちましたか?