Show Menu
화제×

개체 업데이트

PATCH 요청 경로에 카탈로그 개체의 ID를 포함하여 카탈로그 개체의 일부를 업데이트할 수 있습니다. 이 문서에서는 카탈로그 객체에서 PATCH 작업을 수행하는 두 가지 방법에 대해 설명합니다.
  • 필드 사용
  • JSON 패치 표기법 사용
객체에 대한 패치 작업은 상호 관련 개체를 나타내는 확장 가능한 필드를 수정할 수 없습니다. 관련 개체를 직접 수정해야 합니다.

필드를 사용하여 업데이트

다음 예제 호출에서는 필드 및 값을 사용하여 개체를 업데이트하는 방법을 보여 줍니다.
API 형식
PATCH /{OBJECT_TYPE}/{OBJECT_ID}

매개 변수
설명
{OBJECT_TYPE}
업데이트할 카탈로그 개체의 유형입니다. 유효한 개체는 다음과 같습니다.
  • accounts
  • batches
  • connections
  • dataSets
  • dataSetFiles
  • dataSetViews
{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에 설명된 대로 JSON 패치를 사용하여 개체를 업데이트하는 방법을 보여 줍니다 .
API 형식
PATCH /{OBJECT_TYPE}/{OBJECT_ID}

매개 변수
설명
{OBJECT_TYPE}
업데이트할 카탈로그 개체의 유형입니다. 유효한 개체는 다음과 같습니다.
  • accounts
  • batches
  • connections
  • dataSets
  • dataSetFiles
  • dataSetViews
{OBJECT_ID}
업데이트할 특정 개체의 식별자입니다.
요청
다음 요청은 데이터 세트의 name description 필드를 각 JSON 패치 개체에 제공된 값으로 업데이트합니다. JSON 패치를 사용할 때는 컨텐츠 유형 헤더도 로 설정해야 합니다 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"
]