更新Catalog对象

可以通过将Catalog对象的ID包含在PATCH请求的路径中,来更新该对象的一部分。 本文档介绍了对目录对象执行PATCH操作的两种方法:

  • 使用字段
  • 使用JSON修补程序表示法
注意

对象上的PATCH操作无法修改其可扩展字段,这些字段表示相关对象。 必须直接修改相关对象。

使用字段更新

下面的示例调用演示了如何使用字段和值更新对象。

API格式

PATCH /{OBJECT_TYPE}/{OBJECT_ID}
参数 描述
{OBJECT_TYPE} 要更新的Catalog对象的类型。 有效对象包括:
  • accounts
  • batches
  • connections
  • dataSets
  • dataSetFiles
  • dataSetViews
{OBJECT_ID} 要更新的特定对象的标识符。

请求

以下请求将数据集的namedescription字段更新为负载中提供的值。 无法更新的对象字段可以从负载中排除。

curl -X PATCH \
  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":"Updated Dataset Name",
       "description":"Updated description for Sample Dataset"
      }'

响应

成功的响应会返回一个包含已更新数据集ID的数组。 此ID应与在PATCH请求中发送的ID匹配。 现在,对此数据集执行GET请求时显示,只有namedescription已更新,而所有其他值保持不变。

[
    "@/dataSets/5ba9452f7de80400007fc52a"
]

使用JSON修补程序表示法更新

以下示例调用演示了如何使用JSON修补程序更新对象,如RFC-6902中所述。

API格式

PATCH /{OBJECT_TYPE}/{OBJECT_ID}
参数 描述
{OBJECT_TYPE} 要更新的Catalog对象的类型。 有效对象包括:
  • accounts
  • batches
  • connections
  • dataSets
  • dataSetFiles
  • dataSetViews
{OBJECT_ID} 要更新的特定对象的标识符。

请求

以下请求将数据集的namedescription字段更新为每个JSON Patch对象中提供的值。 使用JSON修补程序时,还必须将Content-Type头设置为application/json-patch+json

curl -X PATCH \
  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}' \
  -H 'Content-Type: application/json-patch+json' \
  -d '[
        { "op": "add", "path": "/name", "value": "New Dataset Name" },
        { "op": "add", "path": "/description", "value": "New description for dataset" }
      ]'

响应

成功的响应返回一个包含已更新对象ID的数组。 此ID应与在PATCH请求中发送的ID匹配。 现在,对此对象执行GET请求时显示,只有namedescription已更新,而所有其他值保持不变。

[
    "@/dataSets/5ba9452f7de80400007fc52a"
]

在此页面上