Buscar entidades individuales
Este extremo de búsqueda se puede utilizar para recuperar una lista de todos los objetos indizados de texto completo dentro del área de nombres especificada. Se pueden utilizar varios parámetros separados por el símbolo "et" (&).
Formato de 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 | Descripción |
|---|---|
schema.name={SCHEMA} | (Obligatorio) Donde {SCHEMA} contiene el valor de clase de esquema asociado con los objetos de búsqueda. Actualmente, solo se admite _xdm.context.segmentdefinition. |
namespace={NAMESPACE} | (Obligatorio) Donde {NAMESPACE} contiene el área de nombres en el que desea buscar. |
s={SEARCH_TERM} | (Opcional) Donde {SEARCH_TERM} contiene una consulta que se ajusta a la implementación de Microsoft de sintaxis de búsqueda de Lucene. Si no se especifica ningún término de búsqueda, se devolverán todos los registros asociados con schema.name. Encontrará una explicación más detallada en el apéndice de este documento. |
entityId={ENTITY_ID} | (Opcional) Limita su búsqueda a dentro de la carpeta designada, especificada con {ENTITY_ID}. |
limit={LIMIT} | (Opcional) Donde {LIMIT} representa el número de resultados de búsqueda que se van a devolver. El valor predeterminado es 50. |
page={PAGE} | (Opcional) Donde {PAGE} representa el número de página utilizado para paginar los resultados de la consulta buscada. Tenga en cuenta que el número de página comienza en 0. |
Solicitud
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'
Respuesta
Una respuesta correcta devuelve el estado HTTP 200 con resultados que coinciden con la consulta de búsqueda.
{
"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"
}
}
Obtener información estructural sobre un objeto de búsqueda
Este extremo de búsqueda se puede utilizar para obtener la información estructural sobre el objeto de búsqueda solicitado.
Formato de API
GET /search/taxonomy?schema.name={SCHEMA}&namespace={NAMESPACE}&entityId={ENTITY_ID}
| Parámetros | Descripción |
|---|---|
schema.name={SCHEMA} | (Obligatorio) Donde {SCHEMA} contiene el valor de clase de esquema asociado con los objetos de búsqueda. Actualmente, solo se admite _xdm.context.segmentdefinition. |
namespace={NAMESPACE} | (Obligatorio) Donde {NAMESPACE} contiene el área de nombres en el que desea buscar. |
entityId={ENTITY_ID} | (obligatorio) El identificador del objeto de búsqueda del que desea obtener la información estructural, especificado con {ENTITY_ID}. |
Solicitud
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'
Respuesta
Una respuesta correcta devuelve el estado HTTP 200 con información estructural detallada sobre el objeto de búsqueda 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"
}
}
Pasos siguientes
Después de leer esta guía, ahora comprende mejor cómo funciona la búsqueda de segmentos.
Apéndice
Las secciones siguientes proporcionan información adicional sobre cómo funcionan los términos de búsqueda. Las consultas de búsqueda se escriben de la siguiente manera: s={FieldName}:{SearchExpression}. AAM Por lo tanto, para buscar una definición de segmento denominada o Platform, debe utilizar la siguiente consulta de búsqueda: s=segmentName:AAM%20OR%20Platform.
Para prácticas recomendadas, la expresión de búsqueda debe estar codificada en el HTML, como en el ejemplo anterior.
Campos de búsqueda
En la tabla siguiente se enumeran los campos en los que se puede buscar dentro del parámetro de consulta de búsqueda.
| Nombre del campo | Descripción |
|---|---|
| folderId | Carpeta o carpetas que tienen el ID de carpeta de la búsqueda especificada. |
| folderLocation | La ubicación o ubicaciones que tienen la ubicación de carpeta de la búsqueda especificada. |
| parentFolderId | La definición del segmento o la carpeta que tienen el ID de carpeta principal de la búsqueda especificada. |
| segmentId | La definición del segmento que coincide con el ID del segmento de la búsqueda especificada. |
| segmentName | La definición del segmento que coincide con el nombre del segmento de la búsqueda especificada. |
| segmentDescription | La definición del segmento que coincide con la descripción del segmento de la búsqueda especificada. |