You can look up specific decisions by making a GET request to the Offer Library API that includes either the decisions @id
or the name of the decision in the request path.
API format
GET /{ENDPOINT_PATH}/{CONTAINER_ID}/queries/core/search?schema={SCHEMA_ACTIVITIES}&{QUERY_PARAMS}
Parameter | Description | Example |
---|---|---|
{ENDPOINT_PATH} |
The endpoint path for repository APIs. | https://platform.adobe.io/data/core/xcore/ |
{CONTAINER_ID} |
The container where the decisions are located. | e0bd8463-0913-4ca1-bd84-6309134ca1f6 |
{SCHEMA_ACTIVITIES} |
Defines the schema associated with decisions. | https://ns.adobe.com/experience/offer-management/offer-activity;version=0.5 |
id |
A string used to match the @id property of the entities. The string is matched exactly. The parameters id and name cannot be used together. |
xcore:offer-activity:124527ab00b2ebbc |
name |
A string used to match the xdm:name property of the entities. The string is matched exactly, with capitalization, but wild card characters can be used. The parameter “id” and “name” cannot be used together | LBAR |
Request
curl -X GET \
'https://platform.adobe.io/data/core/xcore/e0bd8463-0913-4ca1-bd84-6309134ca1f6/instances?schema=https://ns.adobe.com/experience/offer-management/offer-activity;version=0.5&id=xcore:offer-activity:124527ab00b2ebbc' \
-H 'Accept: *,application/vnd.adobe.platform.xcore.hal+json; schema="https://ns.adobe.com/experience/xcore/hal/results"' \
-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}'
Response
A successful response returns the details of the placement including information about your container ID, instance ID and, unique decision @id
.
{
"containerId": "e0bd8463-0913-4ca1-bd84-6309134ca1f6",
"schemaNs": "https://ns.adobe.com/experience/offer-management/offer-activity;version=0.5",
"requestTime": "2023-10-19T19:50:08.047489Z",
"_embedded": {
"results": [
{
"instanceId": "4e0206d0-0e6a-11eb-884a-c1a1104e3d7d",
"schemas": [
"https://ns.adobe.com/experience/offer-management/offer-activity;version=0.5"
],
"productContexts": [
"acp"
],
"repo:etag": 1,
"repo:createdDate": "2023-10-14T22:12:10.300775Z",
"repo:lastModifiedDate": "2023-10-14T22:12:10.300775Z",
"repo:createdBy": "{CREATED_BY}",
"repo:lastModifiedBy": "{MODIFIED_BY}",
"repo:createdByClientId": "{CREATED_CLIENT_ID}",
"repo:lastModifiedByClientId": "{MODIFIED_CLIENT_ID}",
"_score": 0,
"_instance": {
"xdm:fallback": "xcore:fallback-offer:1233160780eaa2ef",
"xdm:name": "LBAR",
"xdm:endDate": "2021-02-28T08:00:00.000Z",
"xdm:startDate": "2023-10-14T07:00:00.000Z",
"xdm:status": "live",
"xdm:criteria": [
{
"xdm:placements": [
"xcore:offer-placement:122204529514a2c0"
],
"xdm:optionSelection": {
"xdm:filter": "xcore:offer-filter:122a120f234dac7f"
}
}
],
"@id": "xcore:offer-activity:124527ab00b2ebbc"
},
"_links": {
"self": {
"name": "https://ns.adobe.com/experience/offer-management/offer-activity;version=0.5#4e0206d0-0e6a-11eb-884a-c1a1104e3d7d",
"href": "/e0bd8463-0913-4ca1-bd84-6309134ca1f6/instances/4e0206d0-0e6a-11eb-884a-c1a1104e3d7d",
"@type": "https://ns.adobe.com/experience/offer-management/offer-activity;version=0.5"
}
},
"sandboxName": "ode-prod-va7-edge-testing"
}
],
"total": 1,
"count": 1
},
"_links": {
"self": {
"href": "/e0bd8463-0913-4ca1-bd84-6309134ca1f6/instances?schema=https://ns.adobe.com/experience/offer-management/offer-activity;version=0.5&id=xcore:offer-activity:124527ab00b2ebbc",
"@type": "https://ns.adobe.com/experience/xcore/hal/results"
}
}
}