Check schema validity
- Print
- PDF
Check schema validity
- Print
- PDF
Article summary
Did you find this summary helpful?
Thank you for your feedback
The latest service changes have not yet been reflected in this content. We will update the content as soon as possible. Please refer to the Korean version for information on the latest updates.
Validate a schema.
GET https://aitems.apigw.ntruss.com/api/v1/schemas/validation-check
Request
Request body
| Parameter name | Requirement status | Type | Restrictions | Description |
|---|---|---|---|---|
| datasetType | Yes | String | user, item, interaction | Available dataset types |
| name | Yes | String | Start with English letter or underscore ( _ ). English letters, numbers, underscores ( _ ), and hyphens ( - ) are allowed. 3 to 20 characters can be entered. | Schema name |
| fields[].name | Yes | String | Start with English letter or underscore ( _ ). English letters, numbers, underscores (_), and hyphens ( - ) are allowed. 3 to 20 characters can be entered. | Schema field name |
| fields[].type | Yes | Array | string, int, long, boolean, null | Schema field type |
| fields[].categorical | Yes | Boolean | Categorical field status | |
| description | Yes | String | Enter 0 to 100 characters | Schema description |
Response
| Field name | Requirement status | Type | Description | Remarks |
|---|---|---|---|---|
| fields[].name | String | Schema field name | ||
| fields[].type | Array | Schema field type | ||
| fields[].categorical | Boolean | Categorical field status |
Response status
| HTTP Status | Desc |
|---|---|
| 200 | OK (Successfully validated) |
| 400 | Bad Request (Validation failed) |
| 401 | Unauthorized |
| 403 | Forbidden |
| 404 | Not Found |
| 500 | Internal Server Error |
Examples
Request example
POST /api/v1/schemas/validation-check
Host: aitems.apigw.ntruss.com
accept: application/json
x-ncp-iam-access-key: {Access key}
x-ncp-apigw-signature-v2: {API GW signature}
x-ncp-apigw-timestamp: {timestamp}
{
"datasetType": "interaction",
"name": "LogInfo",
"fields": [
{
"name": "USER_ID",
"type": [
"string"
]
},
{
"name": "ITEM_ID",
"type": [
"string"
]
}
],
"description": "desc"
}
Response example
[
{
"name": "TIMESTAMP",
"type": [
"long"
]
}
]
Was this article helpful?