更新目錄物件

Last update: Tue Jul 16 2024 00:00:00 GMT+0000 (Coordinated Universal Time)

主題：
目錄

建立對象：

開發人員

您可以在PATCH要求的路徑中包含物件識別碼，以更新Catalog物件的部分。本文介紹在目錄物件上執行PATCH作業的兩種方法：

使用欄位
使用JSON修補程式標籤法

NOTE

物件上的PATCH作業無法修改其可展開的欄位，這些欄位代表相互關聯的物件。必須直接修改相互關聯的物件。

使用欄位更新

下列範例呼叫示範如何使用欄位和值更新物件。

API格式

PATCH /{OBJECT_TYPE}/{OBJECT_ID}

參數

說明

{OBJECT_TYPE}

要更新的Catalog物件型別。有效的物件包括：

batches
dataSets
dataSetFiles

{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: {ORG_ID}' \
  -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修補程式標籤法更新

下列範例呼叫示範如何使用JSON修補程式更新物件，如RFC-6902中所述。

如需JSON修補程式語法的詳細資訊，請參閱API基礎指南。

API格式

PATCH /{OBJECT_TYPE}/{OBJECT_ID}

參數

說明

{OBJECT_TYPE}

要更新的Catalog物件型別。有效的物件包括：

batches
dataSets
dataSetFiles

{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: {ORG_ID}' \
  -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"
]

recommendation-more-help

c5c02be6-79a3-4a2f-b766-136bffe8b676