MENU
      Get schema list

        Get schema list


        Article summary

        Available in Classic and VPC

        Get the list of all created schemas.

        Request

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

        MethodURI
        GET/schemas

        Request headers

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

        Request query parameters

        The following describes the parameters.

        FieldTypeRequiredDescription
        datasetTypeStringOptionalDataset 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
        offsetIntegerOptionalStart location of query data
        • Default: 0
        limitIntegerOptionalMaximum number of query data
        • Default: 1000

        Request example

        The following is a sample request.

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

        Response

        The following describes the response format.

        Response body

        The following describes the response body.

        FieldTypeRequiredDescription
        schemasArray-Schema information
        offsetInteger-Start location of query data
        limitInteger-Maximum number of query data

        schemas

        The following describes schemas.

        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
        createdDateString-Schema creation date and time
        actionNameString-Sub Account permissions for the queried item
        permissionString-Sub Account permission allowance

        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.

        {
            "schemas": [
                {
                    "datasetType": "interaction",
                    "name": "interaction_schema",
                    "createdDate": "2024-07-30T09:08:09.221",
                    "actionName": "View/getSchemaDetail",
                    "permission": "Allow"
                },
                {
                    "datasetType": "user",
                    "name": "user_schema",
                    "createdDate": "2024-07-30T08:57:37.393",
                    "actionName": "View/getSchemaDetail",
                    "permission": "Allow"
                },
                {
                    "datasetType": "item",
                    "name": "item_schema",
                    "createdDate": "2024-07-30T08:56:29.040",
                    "actionName": "View/getSchemaDetail",
                    "permission": "Allow"
                }
            ],
            "offset": 0,
            "limit": 1000
        }
        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.