MENU
      Add model

        Add model


        Article summary

        Available in Classic and VPC

        Create a new body model to be used for the body of requests and responses.

        Request

        The following describes the request format for the endpoint. The request format is as follows:

        MethodURI
        POST/products/{product-id}/apis/{api-id}/models

        Request headers

        For headers common to API Gateway, see API Gateway common request headers.

        Request path parameters

        The following describes the parameters.

        FieldTypeRequiredDescription
        product-idStringRequiredProduct ID that the API belongs to
        api-idStringRequiredID of the API whose model you want to add

        Request syntax

        The request syntax is as follows.

        {
          "modelDescription" : "modelDescription",
          "modelName" : "modelName",
          "modelSchema" : "modelSchema"
        }
        JSON

        Request body

        The following describes the request body.

        FieldTypeRequiredDescription
        modelDescriptionStringOptionalModel description
        • 0 - 300 characters
        modelNameStringRequiredModel name
        • 0 - 100 characters
        modelSchemaStringRequiredSchema of the model
        • Use JSON schema

        Request example

        The following is a sample request.

        curl --location --request POST 'https://apigateway.apigw.ntruss.com/api/v1/products/********o9/apis/cvcohvd2xj/models' \
        --header 'x-ncp-apigw-timestamp: {Timestamp}' \
        --header 'x-ncp-iam-access-key: {Access Key}' \
        --header 'x-ncp-apigw-signature-v2: {API Gateway Signature}' \
        --header 'Content-Type: application/json' \
        --data '{
          "modelDescription" : "test model for November update",
          "modelName" : "test-Nov",
          "modelSchema" : "{\n  \"type\": \"object\",\n  \"properties\": {\n    \"firstName\": {\n      \"type\": \"string\"\n    },\n    \"lastName\": {\n      \"type\": \"string\"\n    },\n    \"age\": {\n      \"description\": \"Age in years\",\n      \"type\": \"integer\",\n      \"minimum\": 3\n    }\n  },\n  \"required\": [\n    \"firstName\",\n    \"lastName\"\n  ]\n}"
        }'
        Curl

        Response

        The following describes the response format.

        Response syntax

        The response syntax is as follows.

        {
          "modelId" : "modelId",
          "apiId" : "apiId",
          "modelName" : "modelName",
          "modelDescription" : "modelDescription",
          "modelSchema" : "modelSchema"
        }
        JSON

        Response status codes

        For response status codes common to API Gateway, see API Gateway response status codes.

        Response example

        The following is a sample response.

        {
            "modelId": "1nm7ycjcam",
            "apiId": "cvcohvd2xj",
            "modelName": "test-Nov",
            "modelDescription": "test model for November update",
            "modelSchema": "{\n  \"type\": \"object\",\n  \"properties\": {\n    \"firstName\": {\n      \"type\": \"string\"\n    },\n    \"lastName\": {\n      \"type\": \"string\"\n    },\n    \"age\": {\n      \"description\": \"Age in years\",\n      \"type\": \"integer\",\n      \"minimum\": 3\n    }\n  },\n  \"required\": [\n    \"firstName\",\n    \"lastName\"\n  ]\n}"
        }
        JSON

        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.