MENU
      Edit schema description

        Edit schema description


        Article summary

        Available in Classic and VPC

        Edit schema description.

        Request

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

        MethodURI
        PUT/schemas/{schemaName}

        Request headers

        For headers common to all AiTEMS APIs, see Common AiTEMS headers.

        Request path parameters

        The following describes the parameters.

        FieldTypeRequiredDescription
        schemaNameStringRequiredSchema name

        Request body

        The following describes the request body.

        FieldTypeRequiredDescription
        contentStringRequiredSchema description
        • 0 - 100 characters

        Request example

        The following is a sample request.

        curl --location --request GET 'https://aitems.apigw.ntruss.com/api/v1/schemas/item_schema' \
        --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 '{
            "content": "description"
        }'
        Shell

        Response

        The following describes the response format.

        Response body

        The following describes the response body.

        FieldTypeRequiredDescription
        datasetTypeString-Dataset type
        • user | item | interaction
          • user: data containing user information (age, gender, etc.)
          • item: data with product-related information (price, release date, category, etc.)
          • interaction: data that captures the history of interactions between users and products
        nameString-Schema name
        fieldsArray-Schema field information
        descriptionString-Schema description
        createdDateString-Schema creation date and time

        fields

        The following describes fields.

        FieldTypeRequiredDescription
        nameString-Schema field name
        typeArray-Schema field data type
        • string | int | long | boolean | null
        categoricalBoolean-Whether the field is categorical
        • true | false
          • true: categorical data
          • false: uncategorical data
        • Not displayed when false

        Response status codes

        For response status codes common to all AiTEMS APIs, see Common AiTEMS API response status codes.

        Response example

        The following is a sample example.

        {
            "datasetType": "item",
            "name": "item_schema",
            "fields": [
                {
                    "name": "ITEM_ID",
                    "type": [
                        "string"
                    ]
                },
                {
                    "name": "TAG_ID",
                    "type": [
                        "int",
                        "long"
                    ]
                },
                {
                    "name": "TAGWEIGHT",
                    "type": [
                        "int"
                    ]
                }
            ],
            "description": "description",
            "createdDate": "2024-07-30T08:56:29.040"
        }
        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.