Method Response
- Print
- PDF
Method Response
- Print
- PDF
Article Summary
Share feedback
Thanks for sharing your feedback!
Add a method response status
URL
POST https://apigateway.apigw.ntruss.com/api/v1/products/{product-id}/apis/{api-id}/resources/{resource-id}/methods/{method-name}/responses
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 |
| resourceId | path | Y | String | Resource Id Length(Min/Max): 0/10 |
| methodName | path | Y | String | Method Code Allowable values: ANY, GET, POST, PUT, DELETE, PATCH, OPTIONS, HEAD |
Request Body
{
"responseDescription" : "responseDescription",
"statusCode" : 0
}
Response Code
- 201
Response Body
{
"methodResponseDto" : {
"resourceId" : "resourceId",
"responseDescription" : "responseDescription",
"modifier" : "modifier",
"tenantId" : "tenantId",
"apiId" : "apiId",
"methodCode" : "methodCode",
"statusCode" : 0
}
}
Delete a method response
URL
DELETE https://apigateway.apigw.ntruss.com/api/v1/products/{product-id}/apis/{api-id}/resources/{resource-id}/methods/{method-name}/responses/{status-code}
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 |
| resourceId | path | Y | String | Resource Id Length(Min/Max): 0/10 |
| methodName | path | Y | String | Method Code Allowable values: ANY, GET, POST, PUT, DELETE, PATCH, OPTIONS, HEAD |
| statusCode | path | Y | Integer | Status Code |
Request Body
- None
Response Code
- 204
Response Body
- None
Get response status
URL
GET https://apigateway.apigw.ntruss.com/api/v1/products/{product-id}/apis/{api-id}/resources/{resource-id}/methods/{method-name}/responses
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 |
| resourceId | path | Y | String | Resource Id Length(Min/Max): 0/10 |
| methodName | path | Y | String | Method Code Allowable values: ANY, GET, POST, PUT, DELETE, PATCH, OPTIONS, HEAD |
Request Body
- None
Response Code
- 200
Response Body
{
"responses" : [ {
"resourceId" : "resourceId",
"responseDescription" : "responseDescription",
"modifier" : "modifier",
"tenantId" : "tenantId",
"apiId" : "apiId",
"methodCode" : "methodCode",
"statusCode" : 0
} ]
}
Modify response description
URL
PATCH https://apigateway.apigw.ntruss.com/api/v1/products/{product-id}/apis/{api-id}/resources/{resource-id}/methods/{method-name}/responses/{status-code}
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 |
| resourceId | path | Y | String | Resource Id Length(Min/Max): 0/10 |
| methodName | path | Y | String | Method Code Allowable values: ANY, GET, POST, PUT, DELETE, PATCH, OPTIONS, HEAD |
| statusCode | path | Y | Integer | Status Code |
Request Body
{
"responseDescription" : "responseDescription"
}
Response Code
- 200
Response Body
{
"methodResponseDto" : {
"resourceId" : "resourceId",
"responseDescription" : "responseDescription",
"modifier" : "modifier",
"tenantId" : "tenantId",
"apiId" : "apiId",
"methodCode" : "methodCode",
"statusCode" : 0
}
}
Was this article helpful?