スキーマリストの照会
    • PDF

    スキーマリストの照会

    • PDF

    記事の要約

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

    作成されたスキーマの全リストを照会します。

    リクエスト

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

    メソッドURI
    GET/schemas

    リクエストヘッダ

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

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

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

    フィールドタイプ必須の有無説明
    datasetTypeStringOptionalデータセットタイプ
    • user | item | interaction
      • user: ユーザー情報(年齢、性別など)を含むデータ
      • item: 商品関連情報(価格、発売日、カテゴリなど)を含むデータ
      • interaction: ユーザーと商品間の相互作用から得られた記録を含むデータ
    offsetIntegerOptional照会データのスタート位置
    • デフォルト: 0
    limitIntegerOptional照会データの最大数
    • デフォルト: 1,000

    リクエスト例

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

    curl --location --request GET 'https://aitems.apigw.ntruss.com/api/v1/schemas' \
    --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'
    

    レスポンス

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

    レスポンスボディ

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

    フィールドタイプ必須の有無説明
    schemasArray-スキーマ情報
    offsetInteger-照会データのスタート位置
    limitInteger-照会データの最大数

    schemas

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

    フィールドタイプ必須の有無説明
    datasetTypeString-データセットタイプ
    • user | item | interaction
      • user: ユーザー情報(年齢、性別など)を含むデータ
      • item: 商品関連情報(価格、発売日、カテゴリなど)を含むデータ
      • interaction: ユーザーと商品間の相互作用から得られた記録を含むデータ
    nameString-スキーマ名
    createdDateString-スキーマの作成日時
    actionNameString-照会した項目に対する Sub Account権限
    permissionString-Sub Account権限を許可するかどうか

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

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

    レスポンス例

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

    {
        "schemas": [
            {
                "datasetType": "interaction",
                "name": "interaction_schema",
                "createdDate": "2024-07-30T09:08:09.221",
                "actionName": "View/getSchemaDetail",
                "permission": "Allow"
            },
            {
                "datasetType": "user",
                "name": "user_schema",
                "createdDate": "2024-07-30T08:57:37.393",
                "actionName": "View/getSchemaDetail",
                "permission": "Allow"
            },
            {
                "datasetType": "item",
                "name": "item_schema",
                "createdDate": "2024-07-30T08:56:29.040",
                "actionName": "View/getSchemaDetail",
                "permission": "Allow"
            }
        ],
        "offset": 0,
        "limit": 1000
    }
    

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

    Changing your password will log you out immediately. Use the new password to log back in.
    First name must have atleast 2 characters. Numbers and special characters are not allowed.
    Last name must have atleast 1 characters. Numbers and special characters are not allowed.
    Enter a valid email
    Enter a valid password
    Your profile has been successfully updated.