個々のエンティティの検索
この検索エンドポイントを使用すると、指定した名前空間内のすべてのフルテキストインデックス付きオブジェクトのリストを取得できます。 複数のパラメーターを使用する場合は、アンパサンド(&)で区切ります。
API 形式
GET /search/entities?schema.name={SCHEMA}&namespace={NAMESPACE}
GET /search/entities?schema.name={SCHEMA}&namespace={NAMESPACE}&s={SEARCH_TERM}
GET /search/entities?schema.name={SCHEMA}&namespace={NAMESPACE}&entityId={ENTITY_ID}
パラメーター | 説明 |
---|---|
schema.name={SCHEMA} | (必須) ここで、{SCHEMA} には検索オブジェクトに関連付けられたスキーマクラス値が含まれます。 現在は、_xdm.context.segmentdefinition のみがサポートされています。 |
namespace={NAMESPACE} | (必須) 検索 {NAMESPACE} る名前空間が含まれています。 |
s={SEARCH_TERM} | (任意) Microsoftの Lucene の検索構文実装に準拠するクエリが {SEARCH_TERM} に含まれます。 検索語句が指定されていない場合、schema.name に関連付けられているすべてのレコードが返されます。詳しい説明は、このドキュメントの 付録に記載されています。 |
entityId={ENTITY_ID} | (オプション) 検索を、{ENTITY_ID} で指定した指定フォルダー内に制限します。 |
limit={LIMIT} | (オプション) は、返される検索結果の数を表します。 デフォルト値は 50 です。 |
page={PAGE} | (任意) は、検索したクエリの結果をページ分割するために使用されるページ番号を表します。 ページ番号は 0 から始まることに注意してください。 |
リクエスト
curl -X GET \
https://platform.adobe.io/data/core/ups/search/entities?schema.name=_xdm.context.segmentdefinition&namespace=AAMSegments \
-H 'Authorization: Bearer {ACCESS_TOKEN}' \
-H 'Content-Type: application/json' \
-H 'x-api-key: {API_KEY}' \
-H 'x-gw-ims-org-id: {ORG_ID}' \
-H 'x-sandbox-name: {SANDBOX_NAME}' \
-H 'x-ups-search-version: 1.0'
応答
応答に成功すると、HTTP ステータス 200 と、検索クエリに一致する結果が返されます。
{
"entities": [
{
"id": "1012667",
"base64EncodedSourceId": "RFVGamdydHpEdy01ZTE1ZGJlZGE4YjAxMzE4YWExZWY1MzM1",
"sourceId": "DUFjgrtzDw-5e15dbeda8b01318aa1ef533",
"isFolder": true,
"parentFolderId": "974139",
"name": "aam-47995 verification (100)"
},
{
"id": "14653311",
"base64EncodedSourceId": "REVGamduLVgzdy01ZTE2ZjRhNjc1ZDZhMDE4YThhZDM3NmY1",
"sourceId": "DEFjgn-X3w-5e16f4a675d6a018a8ad376f",
"isFolder": false,
"parentFolderId": "324050",
"name": "AAM - Heavy equipment",
"description": "AAM - Acme Equipment"
}
],
"page": {
"totalCount": 2,
"totalPages": 1,
"pageOffset": 0,
"pageSize": 10
},
"status": {
"message": "Success"
}
}
検索オブジェクトに関する構造情報を取得する
この検索エンドポイントを使用して、リクエストされた検索オブジェクトに関する構造情報を取得できます。
API 形式
GET /search/taxonomy?schema.name={SCHEMA}&namespace={NAMESPACE}&entityId={ENTITY_ID}
パラメーター | 説明 |
---|---|
schema.name={SCHEMA} | (必須) ここで、{SCHEMA} には検索オブジェクトに関連付けられたスキーマクラス値が含まれます。 現在は、_xdm.context.segmentdefinition のみがサポートされています。 |
namespace={NAMESPACE} | (必須) 検索 {NAMESPACE} る名前空間が含まれています。 |
entityId={ENTITY_ID} | (必須) 構造情報を取得する検索オブジェクトの ID。{ENTITY_ID} で指定します。 |
リクエスト
curl -X GET \
https://platform.adobe.io/data/core/ups/search/taxonomy?schema.name=_xdm.context.segmentdefinition&namespace=AAMSegments&entityId=porsche11037 \
-H 'Authorization: Bearer {ACCESS_TOKEN}' \
-H 'Content-Type: application/json' \
-H 'x-api-key: {API_KEY}' \
-H 'x-gw-ims-org-id: {ORG_ID}' \
-H 'x-sandbox-name: {SANDBOX_NAME}' \
-H 'x-ups-search-version: 1.0'
応答
リクエストされた検索オブジェクトに関する詳細な構造情報とともに、応答が成功すると、HTTP ステータス 200 が返されます。
{
"taxonomy": [
{
"id": "0",
"base64EncodedSourceId": "RFVGZ01BLTVlNjgzMGZjMzk3YjQ1MThhYWExYTA4Zg2",
"name": "AAMTraits for Cars",
"parentFolderId": "root"
},
{
"id": "150561",
"base64EncodedSourceId": "RFVGamdpRk1BZy01ZTY4MzBmYzM5N2I0NTE4YWFhMWEwOGY1",
"name": "Fast Cars",
"parentFolderId": "carTraits"
},
{
"id": "porsche11037",
"base64EncodedSourceId": "REFGZ01CLTVlNjczMGZjMzk3YjQ1MThhZGIxYTA4Zg==",
"name": "Porsche",
"parentFolderId": "redCarsFolderId"
}
],
"status": {
"message": "Success"
}
}