您可以通过在PATCH请 Catalog 求的路径中包含对象的ID来更新其一部分。 此文档涵盖对目录对象执行PATCH操作的两种方法:
对象上的PATCH操作无法修改其可扩展字段,这些字段表示相互关联的对象。 必须直接修改相关对象。
以下示例调用演示了如何使用字段和值更新对象。
API格式
PATCH /{OBJECT_TYPE}/{OBJECT_ID}
参数 | 描述 |
---|---|
{OBJECT_TYPE} |
要更新 Catalog 的对象类型。 有效对象有:
|
{OBJECT_ID} |
要更新的特定对象的标识符。 |
请求
以下请求将数 name
据集 description
的和字段更新为有效负荷中提供的值。 无法更新的对象字段可以从有效负荷中排除。
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请求时,只 name
显示和 description
已更新,而所有其他值保持不变。
[
"@/dataSets/5ba9452f7de80400007fc52a"
]
以下示例调用演示了如何使用JSON修补程序更新对象,如 RFC-6902中所述。
API格式
PATCH /{OBJECT_TYPE}/{OBJECT_ID}
参数 | 描述 |
---|---|
{OBJECT_TYPE} |
要更新 Catalog 的对象类型。 有效对象有:
|
{OBJECT_ID} |
要更新的特定对象的标识符。 |
请求
以下请求将数 name
据集 description
的和字段更新为每个JSON修补程序对象中提供的值。 使用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请求时,只 name
显示和 description
已更新,而所有其他值保持不变。
[
"@/dataSets/5ba9452f7de80400007fc52a"
]