特定のコレクション修飾子(旧称「タグ」)を検索するには、リクエストパスにコレクション修飾子 @id
またはコレクション修飾子の名前を含んだ GET リクエストを Offer Library API に対して実行します。
API 形式
GET /{ENDPOINT_PATH}/{CONTAINER_ID}/queries/core/search?schema={SCHEMA_TAG}&{QUERY_PARAMS}
パラメーター | 説明 | 例 |
---|---|---|
{ENDPOINT_PATH} |
リポジトリ API のエンドポイントパス。 | https://platform.adobe.io/data/core/xcore/ |
{CONTAINER_ID} |
コレクション修飾子が配置されているコンテナ。 | e0bd8463-0913-4ca1-bd84-6309134ca1f6 |
{SCHEMA_TAG} |
コレクション修飾子に関連付けられたスキーマを定義します。 | https://ns.adobe.com/experience/offer-management/tag;version=0.1 |
id |
エンティティの @id プロパティとマッチするために使用される文字列。文字列は完全にマッチされます。パラメーター id と name は一緒に使用できません。 |
xcore:tag:124e147572cd7866 |
name |
エンティティの xdm:name プロパティとマッチするために使用される文字列。文字列は大文字と小文字を区別して完全にマッチされますが、ワイルドカード文字を使用することもできます。パラメーター id と name は一緒に使用できません。 |
Holiday sales and promotions |
リクエスト
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}' \
応答
正常な応答では、コレクション修飾子の詳細(コンテナ ID、インスタンス ID、一意のコレクション修飾子 @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"
}
}
}