Suchen nach einzelnen Entitäten
Dieser Suchendpunkt kann verwendet werden, um eine Liste aller Volltext-indizierten Objekte innerhalb des angegebenen Namespace abzurufen. Es können mehrere Parameter verwendet werden, die durch kaufmännische Und-Zeichen (&) voneinander getrennt werden.
API-Format
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}
| Parameter | Beschreibung |
|---|---|
schema.name={SCHEMA} | (Erforderlich) Hierbei enthält {SCHEMA} den mit den Suchobjekten verknüpften Schemaklasse-Wert. Derzeit wird nur _xdm.context.segmentdefinition unterstützt. |
namespace={NAMESPACE} | (Erforderlich) Wobei {NAMESPACE} den Namespace enthält, in dem gesucht werden soll. |
s={SEARCH_TERM} | (Optional) Hierbei enthält {SEARCH_TERM} eine Abfrage, die der Microsoft-Implementierung der Suchsyntax von Lucene entspricht. Wenn kein Suchbegriff angegeben wird, werden alle mit schema.name verknüpften Datensätze zurückgegeben. Eine detailliertere Erklärung finden Sie im Anhang dieses Dokuments. |
entityId={ENTITY_ID} | (Optional) Schränkt die Suche auf den angegebenen Ordner ein, der mit {ENTITY_ID} angegeben ist. |
limit={LIMIT} | (Optional) Dabei steht {LIMIT} für die Anzahl der zurückzugebenden Suchergebnisse. Der Standardwert lautet 50. |
page={PAGE} | (Optional) Dabei entspricht {PAGE} der Seitenzahl, die für die Paginierung der Ergebnisse der durchsuchten Abfrage verwendet wird. Bitte beachten Sie, dass die Seitennummer bei 0 beginnt. |
Anfrage
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'
Antwort
Bei einer erfolgreichen Antwort wird der HTTP-Status 200 mit Ergebnissen zurückgegeben, die mit der Suchanfrage übereinstimmen.
{
"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"
}
}
Abrufen von Strukturinformationen zu einem Suchobjekt
Dieser Suchendpunkt kann verwendet werden, um die Strukturinformationen zum angeforderten Suchobjekt abzurufen.
API-Format
GET /search/taxonomy?schema.name={SCHEMA}&namespace={NAMESPACE}&entityId={ENTITY_ID}
| Parameter | Beschreibung |
|---|---|
schema.name={SCHEMA} | (Erforderlich) Hierbei enthält {SCHEMA} den mit den Suchobjekten verknüpften Schemaklasse-Wert. Derzeit wird nur _xdm.context.segmentdefinition unterstützt. |
namespace={NAMESPACE} | (Erforderlich) Wobei {NAMESPACE} den Namespace enthält, in dem gesucht werden soll. |
entityId={ENTITY_ID} | (Erforderlich) Die ID des Suchobjekts, zu dem Sie die Strukturinformationen abrufen möchten, angegeben mit {ENTITY_ID}. |
Anfrage
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'
Antwort
Eine erfolgreiche Antwort gibt den HTTP-Status-Code 200 mit detaillierten Strukturinformationen zum angeforderten Suchobjekt zurück.
{
"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"
}
}