Get schema list

Article summary

Did you find this summary helpful?

Thank you for your feedback

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:

Method	URI
GET	/schemas

Request headers

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

Request query parameters

The following describes the parameters.

Field	Type	Required	Description
`datasetType`	String	Optional	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
`offset`	Integer	Optional	Start location of query data Default: 0
`limit`	Integer	Optional	Maximum 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'

Response

The following describes the response format.

Response body

The following describes the response body.

Field	Type	Required	Description
`schemas`	Array	-	Schema information
`offset`	Integer	-	Start location of query data
`limit`	Integer	-	Maximum number of query data

`schemas`

The following describes schemas.

Field	Type	Required	Description
`datasetType`	String	-	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
`name`	String	-	Schema name
`createdDate`	String	-	Schema creation date and time
`actionName`	String	-	Sub Account permissions for the queried item
`permission`	String	-	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
}

Was this article helpful?

What's Next

Get schema

Table of contents

Request
Response