Method Request Parameter
- 印刷する
- PDF
Method Request Parameter
- 印刷する
- 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}/parameters
リクエストパラメータ
| 名前 | 位置 | 必須かどうか | タイプ | 説明 |
|---|---|---|---|---|
| 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 |
リクエストボディ
{
"isRequired" : true,
"parameterType" : "string",
"isLogged" : true,
"isArray" : true,
"parameterName" : "parameterName",
"parameterDescription" : "parameterDescription",
"parameterCode" : "REQUEST_HEADER"
}
応答コード
- 201
応答ボディ
{
"methodParameterDto" : {
"isRequired" : true,
"parameterType" : "string",
"resourceId" : "resourceId",
"modifier" : "modifier",
"isLogged" : true,
"parameterNo" : 0,
"parameterName" : "parameterName",
"parameterCode" : "REQUEST_HEADER",
"methodCode" : "methodCode",
"tenantId" : "tenantId",
"isArray" : true,
"parameterDescription" : "parameterDescription",
"apiId" : "apiId",
"statusCode" : 6
}
}
メソッドの要求パラメータの削除
URL
POST https://apigateway.apigw.ntruss.com/api/v1/products/{product-id}/apis/{api-id}/resources/{resource-id}/methods/{method-name}/parameters/delete
リクエストパラメータ
| 名前 | 位置 | 必須かどうか | タイプ | 説明 |
|---|---|---|---|---|
| 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 |
リクエストボディ
{
"parameterName" : "parameterName"
}
応答コード
- 204
応答ボディ
- なし
メソッドの要求パラメータ照会
URL
GET https://apigateway.apigw.ntruss.com/api/v1/products/{product-id}/apis/{api-id}/resources/{resource-id}/methods/{method-name}/parameters
リクエストパラメータ
| 名前 | 位置 | 必須かどうか | タイプ | 説明 |
|---|---|---|---|---|
| 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
応答ボディ
{
"headers" : [ {
"isRequired" : true,
"parameterType" : "string",
"resourceId" : "resourceId",
"modifier" : "modifier",
"isLogged" : true,
"parameterNo" : 0,
"parameterName" : "parameterName",
"parameterCode" : "REQUEST_HEADER",
"methodCode" : "methodCode",
"tenantId" : "tenantId",
"isArray" : true,
"parameterDescription" : "parameterDescription",
"apiId" : "apiId",
"statusCode" : 6
} ],
"useBodyWhenFormData" : true,
"isNcpTenant" : true,
"queryStrings" : [ {
"isRequired" : true,
"parameterType" : "string",
"resourceId" : "resourceId",
"modifier" : "modifier",
"isLogged" : true,
"parameterNo" : 0,
"parameterName" : "parameterName",
"parameterCode" : "REQUEST_HEADER",
"methodCode" : "methodCode",
"tenantId" : "tenantId",
"isArray" : true,
"parameterDescription" : "parameterDescription",
"apiId" : "apiId",
"statusCode" : 6
} ],
"formDatas" : [ {
"isRequired" : true,
"parameterType" : "string",
"resourceId" : "resourceId",
"modifier" : "modifier",
"isLogged" : true,
"parameterNo" : 0,
"parameterName" : "parameterName",
"parameterCode" : "REQUEST_HEADER",
"methodCode" : "methodCode",
"tenantId" : "tenantId",
"isArray" : true,
"parameterDescription" : "parameterDescription",
"apiId" : "apiId",
"statusCode" : 6
} ]
}
この記事は役に立ちましたか?