You can look up specific collection qualifiers (previously known as “tags”) by making a GET request to the Offer Library API that includes either the collection qualifier @id
or the name of the collection qualifier in the request path.
API format
GET /{ENDPOINT_PATH}/{CONTAINER_ID}/queries/core/search?schema={SCHEMA_TAG}&{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 collection qualifiers are located. | e0bd8463-0913-4ca1-bd84-6309134ca1f6 |
{SCHEMA_TAG} |
Defines the schema associated with collection qualifiers. | https://ns.adobe.com/experience/offer-management/tag;version=0.1 |
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:tag:124e147572cd7866 |
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 parameters id and name cannot be used together |
Holiday sales and promotions |
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/tag;version=0.1&name=Holiday%20sales%20and%20promotions' \
-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 collection qualifier including information about your container ID, instance ID and, unique collection qualifier @id
.
{
"containerId": "e0bd8463-0913-4ca1-bd84-6309134ca1f6",
"schemaNs": "https://ns.adobe.com/experience/offer-management/tag;version=0.1",
"requestTime": "2020-10-21T20:35:28.233975Z",
"_embedded": {
"results": [
{
"instanceId": "d48fd160-13dc-11eb-bc55-c11be7252432",
"schemas": [
"https://ns.adobe.com/experience/offer-management/tag;version=0.1"
],
"productContexts": [
"acp"
],
"repo:etag": 1,
"repo:createdDate": "2020-10-21T20:34:34.486296Z",
"repo:lastModifiedDate": "2020-10-21T20:34:34.486296Z",
"repo:createdBy": "{CREATED_BY}",
"repo:lastModifiedBy": "{MODIFIED_BY}",
"repo:createdByClientId": "{CREATED_CLIENT_ID}",
"repo:lastModifiedByClientId": "{MODIFIED_CLIENT_ID}",
"_score": 0,
"_instance": {
"xdm:name": "Holiday sales and promotions",
"@id": "xcore:tag:124e147572cd7866"
},
"_links": {
"self": {
"name": "https://ns.adobe.com/experience/offer-management/tag;version=0.1#d48fd160-13dc-11eb-bc55-c11be7252432",
"href": "/e0bd8463-0913-4ca1-bd84-6309134ca1f6/instances/d48fd160-13dc-11eb-bc55-c11be7252432",
"@type": "https://ns.adobe.com/experience/offer-management/tag;version=0.1"
}
}
}
],
"total": 1,
"count": 1
},
"_links": {
"self": {
"href": "/e0bd8463-0913-4ca1-bd84-6309134ca1f6/instances?schema=https://ns.adobe.com/experience/offer-management/tag;version=0.1&name=Holiday%20sales%20and%20promotions",
"@type": "https://ns.adobe.com/experience/xcore/hal/results"
}
}
}