搜索单个实体
此搜索端点可用于检索指定命名空间内所有全文检索对象的列表。 可以使用多个参数，以&分隔。
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} | （可选） 其中{SEARCH_TERM}包含符合Microsoft的Lucene搜索语法实现的查询。 如果未指定搜索词，则将返回与schema.name关联的所有记录。 有关更详细的解释，请参阅本文档的附录。 |
entityId={ENTITY_ID} | （可选） 将您的搜索限制在指定的文件夹内，使用{ENTITY_ID}指定。 |
limit={LIMIT} | （可选） 其中{LIMIT}表示要返回的搜索结果数。 默认值为 50。 |
page={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"
}
}