Method Response Body
    • PDF

    Method Response Body

    • PDF

    Article Summary

    Save method response body

    URL

    POST https://apigateway.apigw.ntruss.com/api/v1/products/{product-id}/apis/{api-id}/resources/{resource-id}/methods/{method-name}/responses/{status-code}/response-body
    

    Request Parameter

    NamePositionRequiredTypeDescription
    productIdpathYStringProduct Id
    Length(Min/Max): 0/10
    apiIdpathYStringApi Id
    Length(Min/Max): 0/10
    resourceIdpathYStringResource Id
    Length(Min/Max): 0/10
    methodNamepathYStringMethod Code
    Allowable values: ANY, GET, POST, PUT, DELETE, PATCH, OPTIONS, HEAD
    statusCodepathYIntegerStatus Code

    Request Body

    {
      "bodyName" : "bodyName",
      "modelId" : "modelId",
      "bodyDescription" : "bodyDescription"
    }
    

    Response Code

    • 201

    Response Body

    {
      "modelName" : "modelName",
      "bodyName" : "bodyName",
      "modelId" : "modelId",
      "bodyDescription" : "bodyDescription"
    }
    

    Delete method response body

    URL

    DELETE https://apigateway.apigw.ntruss.com/api/v1/products/{product-id}/apis/{api-id}/resources/{resource-id}/methods/{method-name}/responses/{status-code}/response-body
    

    Request Parameter

    NamePositionRequiredTypeDescription
    productIdpathYStringProduct Id
    Length(Min/Max): 0/10
    apiIdpathYStringApi Id
    Length(Min/Max): 0/10
    resourceIdpathYStringResource Id
    Length(Min/Max): 0/10
    methodNamepathYStringMethod Code
    Allowable values: ANY, GET, POST, PUT, DELETE, PATCH, OPTIONS, HEAD
    statusCodepathYIntegerStatus Code

    Request Body

    • None

    Response Code

    • 204

    Response Body

    • None

    Get method response body

    URL

    GET https://apigateway.apigw.ntruss.com/api/v1/products/{product-id}/apis/{api-id}/resources/{resource-id}/methods/{method-name}/responses/{status-code}/response-body
    

    Request Parameter

    NamePositionRequiredTypeDescription
    productIdpathYStringProduct Id
    Length(Min/Max): 0/10
    apiIdpathYStringApi Id
    Length(Min/Max): 0/10
    resourceIdpathYStringResource Id
    Length(Min/Max): 0/10
    methodNamepathYStringMethod Code
    Allowable values: ANY, GET, POST, PUT, DELETE, PATCH, OPTIONS, HEAD
    statusCodepathYIntegerStatus Code

    Request Body

    • None

    Response Code

    • 200

    Response Body

    {
      "modelName" : "modelName",
      "bodyName" : "bodyName",
      "modelId" : "modelId",
      "bodyDescription" : "bodyDescription"
    }
    

    Was this article helpful?

    Changing your password will log you out immediately. Use the new password to log back in.
    First name must have atleast 2 characters. Numbers and special characters are not allowed.
    Last name must have atleast 1 characters. Numbers and special characters are not allowed.
    Enter a valid email
    Enter a valid password
    Your profile has been successfully updated.