Method Response Header
- Print
- PDF
Method Response Header
- Print
- PDF
Article Summary
Share feedback
Thanks for sharing your feedback!
Add a response header on a method
URL
POST https://apigateway.apigw.ntruss.com/api/v1/products/{product-id}/apis/{api-id}/resources/{resource-id}/methods/{method-name}/responses/{status-code}/parameters
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
{
"parameterType" : "string",
"isArray" : true,
"parameterName" : "parameterName",
"parameterDescription" : "parameterDescription"
}
Response Code
- 201
Response Body
{
"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
}
}
Delete a response header by name
URL
DELETE https://apigateway.apigw.ntruss.com/api/v1/products/{product-id}/apis/{api-id}/resources/{resource-id}/methods/{method-name}/responses/{status-code}/parameters/{parameter-name}
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 |
| parameterName | path | Y | String | Parameter Name |
Request Body
- None
Response Code
- 204
Response Body
- None
Get response header list by status code
URL
GET https://apigateway.apigw.ntruss.com/api/v1/products/{product-id}/apis/{api-id}/resources/{resource-id}/methods/{method-name}/responses/{status-code}/parameters
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
- 200
Response Body
{
"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
} ]
}
Was this article helpful?