Pesquisar entidades individuais
Esse ponto de extremidade de pesquisa pode ser usado para recuperar uma lista de todos os objetos indexados de texto completo no namespace especificado. Vários parâmetros podem ser usados, separados por "E" comercial (&).
Formato da 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}
| Parâmetros | Descrição |
|---|---|
schema.name={SCHEMA} | (Obrigatório) Onde {SCHEMA} contém o valor da classe de esquema associado aos objetos de pesquisa. Atualmente, somente _xdm.context.segmentdefinition é suportado. |
namespace={NAMESPACE} | (Obrigatório) Onde {NAMESPACE} contém o namespace no qual você deseja pesquisar. |
s={SEARCH_TERM} | (Opcional) Onde {SEARCH_TERM} contém uma consulta que está em conformidade com a implementação da sintaxe de pesquisa da Lucene pela Microsoft. Se nenhum termo de pesquisa for especificado, todos os registros associados a schema.name serão retornados. Uma explicação mais detalhada pode ser encontrada no apêndice deste documento. |
entityId={ENTITY_ID} | (Opcional) Limita sua pesquisa à pasta designada, especificada com {ENTITY_ID}. |
limit={LIMIT} | (Opcional) Onde {LIMIT} representa o número de resultados da pesquisa a serem retornados. O valor padrão é 50. |
page={PAGE} | (Opcional) Onde {PAGE} representa o número de página usado para paginar os resultados da consulta pesquisada. Observe que o número da página começa em 0. |
Solicitação
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'
Resposta
Uma resposta bem-sucedida retorna o status HTTP 200 com resultados correspondentes à consulta de pesquisa.
{
"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"
}
}
Obter informações estruturais sobre um objeto de pesquisa
Esse endpoint de pesquisa pode ser usado para obter as informações estruturais sobre o objeto de pesquisa solicitado.
Formato da API
GET /search/taxonomy?schema.name={SCHEMA}&namespace={NAMESPACE}&entityId={ENTITY_ID}
| Parâmetros | Descrição |
|---|---|
schema.name={SCHEMA} | (Obrigatório) Onde {SCHEMA} contém o valor da classe de esquema associado aos objetos de pesquisa. Atualmente, somente _xdm.context.segmentdefinition é suportado. |
namespace={NAMESPACE} | (Obrigatório) Onde {NAMESPACE} contém o namespace no qual você deseja pesquisar. |
entityId={ENTITY_ID} | (Obrigatório) A ID do objeto de pesquisa sobre o qual você deseja obter as informações estruturais, especificada com {ENTITY_ID}. |
Solicitação
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'
Resposta
Uma resposta bem-sucedida retorna o status HTTP 200 com informações estruturais detalhadas sobre o objeto de pesquisa solicitado.
{
"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"
}
}