Edit schema description
- Print
- PDF
Edit schema description
- Print
- PDF
Article summary
Did you find this summary helpful?
Thank you for your feedback
Available in Classic and VPC
Edit schema description.
Request
The following describes the request format for the endpoint. The request format is as follows:
Method | URI |
---|---|
PUT | /schemas/{schemaName} |
Request headers
For headers common to all AiTEMS APIs, see Common AiTEMS headers.
Request path parameters
The following describes the parameters.
Field | Type | Required | Description |
---|---|---|---|
schemaName | String | Required | Schema name
|
Request body
The following describes the request body.
Field | Type | Required | Description |
---|---|---|---|
content | String | Required | Schema description
|
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"
}'
Response
The following describes the response format.
Response body
The following describes the response body.
Field | Type | Required | Description |
---|---|---|---|
datasetType | String | - | Dataset type
|
name | String | - | Schema name |
fields | Array | - | Schema field information |
description | String | - | Schema description |
createdDate | String | - | Schema creation date and time |
fields
The following describes fields
.
Field | Type | Required | Description |
---|---|---|---|
name | String | - | Schema field name |
type | Array | - | Schema field data type
|
categorical | Boolean | - | Whether the field is categorical
|
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"
}
Was this article helpful?