API でのオブジェクトの削除

Catalog オブジェクトを削除するには、削除リクエストのパスに ID を指定します。DELETE

警告

オブジェクトの削除は元に戻せず、Experience Platform の他の場所で破壊的な変更が生じる可能性があるので、特に注意が必要です。

API 形式

DELETE /{OBJECT_TYPE}/{OBJECT_ID}
重要

DELETE /batches/{ID} エンドポイントは非推奨です。 バッチを削除するには、 バッチ取得 API を使用する必要があります。

パラメーター 説明
{OBJECT_TYPE} 削除する Catalog オブジェクトの種類。 有効なオブジェクトは次のとおりです。
  • accounts
  • connections
  • dataSets
  • dataSetFiles
  • dataSetViews
{OBJECT_ID} 更新する特定のオブジェクトの識別子。

リクエスト

次のリクエストを実行すると、リクエストパスで ID が指定されたデータセットが削除されます。

curl -X DELETE \
  'https://platform.adobe.io/data/foundation/catalog/dataSets/5ba9452f7de80400007fc52a' \
  -H 'Authorization: Bearer {ACCESS_TOKEN}' \
  -H 'x-api-key: {API_KEY}' \
  -H 'x-gw-ims-org-id: {IMS_ORG}' \
  -H 'x-sandbox-name: {SANDBOX_NAME}'

応答

リクエストが成功した場合は、削除したデータセットの ID を含む配列と HTTP ステータス 200(OK)が返されます。この ID は、DELETE リクエストで送信された ID と一致します。削除したオブジェクトに対して GET リクエストを実行すると、HTTP ステータス 404(Not Found)が返され、データセットが正常に削除されたことがわかります。

[
    "@/dataSets/5ba9452f7de80400007fc52a"
]
メモ

リクエストで指定した ID に一致する Catalog オブジェクトがない場合でも、HTTP ステータスコード 200 が表示される可能性がありますが、応答配列は空になります。

このページ