Offer Library API に対して PATCH リクエストを実行することで、コンテナ内の決定を変更または更新できます。
使用可能な操作など、JSON パッチの詳細については、JSON パッチの公式ドキュメントを参照してください。
次の表に、リクエストヘッダーの 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/offer-activity;version=0.5" |
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。 | f88c9be0-1245-11eb-8622-b77b60702882 |
リクエスト
curl -X PATCH \
'https://platform.adobe.io/data/core/xcore/e0bd8463-0913-4ca1-bd84-6309134ca1f6/instances/f88c9be0-1245-11eb-8622-b77b60702882' \
-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/offer-activity;version=0.5"' \
-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": "Example Activity Name"
}
]'
パラメーター | 説明 |
---|---|
op |
接続の更新に必要なアクションを定義するために使用される操作呼び出し。操作には、add 、replace 、remove があります。 |
path |
更新するパラメーターのパス。 |
value |
パラメーターの更新に使用する新しい値。 |
応答
応答が成功すると、更新された決定の詳細(一意のインスタンス ID と決定 @id
を含む)が返されます。
{
"instanceId": "f88c9be0-1245-11eb-8622-b77b60702882",
"@id": "xcore:offer-activity:124b79dc3ce2d720",
"repo:etag": 2,
"repo:createdDate": "2020-10-19T20:02:09.694067Z",
"repo:lastModifiedDate": "2020-10-19T21:28:24.284719Z",
"repo:createdBy": "{CREATED_BY}",
"repo:lastModifiedBy": "{MODIFIED_BY}",
"repo:createdByClientId": "{CREATED_CLIENT_ID}",
"repo:lastModifiedByClientId": "{MODIFIED_CLIENT_ID}"
}