カタログオブジェクトの置換

PUTリクエストを使用して Catalog オブジェクトの内容を上書きできます。この場合、リソース全体がリクエストペイロードで置き換えられます。

メモ

Catalog オブジェクト内の特定のフィールドのみを更新する必要がある場合は、PATCHリクエストを使用する方が効率的です。

API 形式

PUT /{OBJECT_TYPE}/{OBJECT_ID}
パラメーター 説明
{OBJECT_TYPE} 置き換える Catalog オブジェクトのタイプ。 有効なオブジェクトは次のとおりです。
  • accounts
  • batches
  • connections
  • dataSets
  • dataSetFiles
  • dataSetViews
{OBJECT_ID} 更新する特定のオブジェクトの識別子。

リクエスト

次のリクエストは、ペイロードで指定された値でデータセットを上書きします。

curl -X PUT \
  https://platform.adobe.io/data/foundation/catalog/dataSets/5ba9452f7de80400007fc52a \
  -H 'Authorization: Bearer {ACCESS_TOKEN}' \
  -H 'Content-Type: application/json' \
  -H 'x-api-key: {API_KEY}' \
  -H 'x-gw-ims-org-id: {IMS_ORG}' \
  -H 'x-sandbox-name: {SANDBOX_NAME}' \
  -d '{
        "name": "New Dataset Name",
        "description": "New description for dataset",
        "state": "DRAFT",
        "tags": {
            "adobe/pqs/table": [
                "sample_dataset"
            ]
        },
        "files": "@/dataSets/5ba9452f7de80400007fc52a/views/5ba9452f7de80400007fc52b/files"
    }'

応答

成功した場合は、上書きされたオブジェクトの ID を含む配列が返されます。この ID は、PUT リクエストで送信された ID と一致する必要があります。このオブジェクトに対して GET リクエストを実行すると、その詳細が以前の PUT リクエストのペイロードで提供された詳細に置き換えられたことが示されます。

[
    "@/dataSets/5ba9452f7de80400007fc52a"
]

このページ