リクエスト

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

メソッド	URI
PUT	/schemas/{schemaName}

リクエストヘッダ

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

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

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

フィールド	タイプ	必須の有無	説明
`schemaName`	String	Required	スキーマ名スキーマリストの照会を通じて確認

リクエストボディ

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

フィールド	タイプ	必須の有無	説明
`content`	String	Required	スキーマの説明 0~100文字

リクエスト例

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

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

レスポンス

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

レスポンスボディ

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

フィールド	タイプ	必須の有無	説明
`datasetType`	String	-	データセットタイプ `user` \| `item` \| `interaction` `user`: ユーザー情報(年齢、性別など)を含むデータ `item`: 商品関連情報(価格、発売日、カテゴリなど)を含むデータ `interaction`: ユーザーと商品間の相互作用から得られた記録を含むデータ
`name`	String	-	スキーマ名
`fields`	Array	-	スキーマフィールド情報
`description`	String	-	スキーマの説明
`createdDate`	String	-	スキーマの作成日時

`fields`

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

フィールド	タイプ	必須の有無	説明
`name`	String	-	スキーマフィールドの名前
`type`	Array	-	スキーマフィールドのデータタイプ `string` \| `int` \| `long` \| `boolean` \| `null`
`categorical`	Boolean	-	カテゴリ型かどうか `true` \| `false` `true`: カテゴリが決まっているデータ `false`: カテゴリが決まっていないデータ `false`の場合は表示されない

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

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

この記事は役に立ちましたか?

リクエスト
レスポンス

タグ

AiTEMS