コレクション修飾子の更新

Offer Library APIに対して PATCH リクエストを実行することで、コンテナ内のコレクション修飾子 （旧称「タグ」）を変更または更新できます。

使用可能な操作など、JSON パッチの詳細については、JSON パッチの公式ドキュメントを参照してください。

Accept ヘッダーと Content-Type ヘッダー

次の表に、リクエストヘッダーの Content-Type フィールドと Accept フィールドを構成する有効な値を示します。

ヘッダー名 値
Accept application/vnd.adobe.platform.xcore.xdm.receipt+json; version=1
Content-Type application/vnd.adobe.platform.xcore.patch.hal+json; version=1; schema="https://ns.adobe.com/experience/offer-management/tag;version=0.1"

API 形式

PATCH /{ENDPOINT_PATH}/{CONTAINER_ID}/instances/{INSTANCE_ID}
パラメーター 説明 例
{ENDPOINT_PATH} リポジトリ API のエンドポイントパス。 https://platform.adobe.io/data/core/xcore/
{CONTAINER_ID} タグが配置されているコンテナ。 e0bd8463-0913-4ca1-bd84-6309134ca1f6
{INSTANCE_ID} 更新するタグのインスタンス ID。 d48fd160-13dc-11eb-bc55-c11be7252432

リクエスト

curl -X PATCH \
  'https://platform.adobe.io/data/core/xcore/e0bd8463-0913-4ca1-bd84-6309134ca1f6/instances/d48fd160-13dc-11eb-bc55-c11be7252432' \
  -H 'Accept: application/vnd.adobe.platform.xcore.xdm.receipt+json; version=1' \
  -H 'Content-Type: application/vnd.adobe.platform.xcore.patch.hal+json; version=1; schema="https://ns.adobe.com/experience/offer-management/tag;version=0.1"' \
  -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}'\
  -d '[
        {
          "op": "replace",
          "path": "/_instance/xdm:name",
          "value": "Sales and promotions for the holidays"
        }
    ]'
パラメーター 説明
op 接続の更新に必要なアクションを定義するために使用される操作呼び出し。操作には、add、replace、remove があります。
path 更新するパラメーターのパス。
value パラメーターの更新に使用する新しい値。

応答

正常な応答では、コレクション修飾子の更新された詳細（一意のインスタンス ID とコレクション修飾子 @id を含む）が返されます。

{
    "instanceId": "d48fd160-13dc-11eb-bc55-c11be7252432",
    "@id": "xcore:tag:124e147572cd7866",
    "repo:etag": 2,
    "repo:createdDate": "2020-10-21T20:34:34.486296Z",
    "repo:lastModifiedDate": "2020-10-21T20:36:31.782607Z",
    "repo:createdBy": "{CREATED_BY}",
    "repo:lastModifiedBy": "{MODIFIED_BY}",
    "repo:createdByClientId": "{CREATED_CLIENT_ID}",
    "repo:lastModifiedByClientId": "{MODIFIED_CLIENT_ID}"
}

このページ