スキーマの有効性チェック

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

入力したスキーマ情報が使用可能かどうかを検証します。

リクエスト

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

リクエストヘッダ

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

リクエストボディ

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

fields

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

リクエスト例

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

curl --location --request POST 'https://aitems.apigw.ntruss.com/api/v1/schemas/validation-check' \
--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 '{
    "datasetType": "user",
    "name": "user_schema",
    "fields": [
        {
            "name": "USER_ID",
            "type": [
                "string"
            ],
            "categorical": false
        }
    ],
    "description": "desc"
}'

レスポンス

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

レスポンスボディ

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

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

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

レスポンス例

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

[
    {
        "name": "USER_ID",
        "type": [
            "string"
        ]
    }
]