スキーマ説明の変更

Classic/VPC環境で利用できます。

スキーマの説明を変更します。

リクエスト

リクエスト形式を説明します。リクエスト形式は次の通りです。

リクエストヘッダ

AiTEMS APIで共通して使用されるヘッダの詳細は、AiTEMSの共通ヘッダをご参照ください。

リクエストパスパラメータ

パラメータの説明は次の通りです。

リクエストボディ

リクエストボディの説明は次の通りです。

リクエスト例

リクエストのサンプルコードは次の通りです。

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"
}'

レスポンス

レスポンス形式を説明します。

レスポンスボディ

レスポンスボディの説明は次の通りです。

fields

fieldsの説明は次の通りです。

レスポンスステータスコード

AiTEMS APIで共通して使用されるレスポンスステータスコードの詳細は、AiTEMS APIの共通レスポンスステータスコードをご参照ください。

レスポンス例

レスポンスのサンプルコードは次の通りです。

{
    "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"
}