API-Referenz: Suche

Der Suchendpunkt führt eine globale semantische Suche über die Inhalte des Mandanten aus. Mit einer kostenlosen Testphase können Sie die Suche in Ihrem eigenen Arbeitsbereich ausprobieren.

Globale Suche in Rollen, Prozessen, Elementen, Dokumentation, Versionen und Kommentaren des Mandanten

Die Anzahl der Anfragen pro Mandant ist begrenzt. Eine 429-Antwort enthält den gemeinsamen Nachrichtentext ({“message”: “Too many search requests, please slow down.”}).

Endpunkt: POST /v1/tenant/{tenantId}/search

Authentifizierung: Mandantenbezogener API-Schlüssel · read Berechtigungsumfang

Parameter:

Name	Typ	Speicherort	Erforderlich	Beschreibung
tenantId	string	path	Ja	Format: `uuid`

Anfragetext:

{
	"query": "string",
	"mode": "semantic",
	"categories": [
		"role"
	],
	"processId": "00000000-0000-0000-0000-000000000000",
	"k": 0
}

Feld	Typ	Erforderlich	Beschreibung
query	string	Ja	Suchanfrage Maximale Länge: 1000
mode	`semantic` \| `exact` \| `hybrid`	Nein	semantic = Embeddings, exact = wörtliche Suche, hybrid = beides Zulässige Werte: `semantic`, `exact`, `hybrid` Standard: `hybrid`
categories	`role` \| `process` \| `element` \| `documentation` \| `version` \| `comment`[]	Nein	Ergebnisse auf diese Kategorien beschränken
processId	string	Nein	Ergebnisse auf einen einzelnen Prozess beschränken Format: `uuid`
k	integer	Nein	Anzahl der zurückzugebenden Ergebnisse Standard: `20` Minimum: 1 Maximum: 50

Antwort (200):

Suchergebnisse (Treffer, Anzahl, Gesamtzahl, Vorschläge)

{
	"hits": [
		{
			"category": "role",
			"entityType": "role",
			"entityId": "string",
			"subKey": "string",
			"title": "string",
			"snippet": "string",
			"score": 0,
			"processId": "00000000-0000-0000-0000-000000000000",
			"processDisplayName": "string",
			"elementType": "string",
			"docSection": "string",
			"url": "string"
		}
	],
	"counts": {},
	"total": 0,
	"suggestions": [
		"string"
	]
}

Feld	Typ	Erforderlich
hits	object[]	Ja
counts	object	Ja
total	number	Ja
suggestions	string[]	Ja

Fehler:

401 API-Schlüssel fehlt, ist ungültig, deaktiviert oder abgelaufen
429 Anfragelimit erreicht: Beachten Sie das für den Endpunkt dokumentierte Limit

Zugehörige Dokumentation

API-Referenz: Organisationen

API-Referenz für Endpunkte zur Verwaltung von Organisationen und Benutzern.

API-Referenz: Mandanten

API-Referenz für Endpunkte zur Mandantenverwaltung und zur Steuerung des Benutzerzugriffs.

API-Referenz: Daten

API-Referenz für Endpunkte zur Verwaltung von Datensätzen und Datentabellen.

API-Referenz: Prozesse

API-Referenz für Endpunkte zur Prozessverwaltung und Datenzuordnung.

Verbessern Sie Prozesse. Schaffen Sie eine vernetzte Architektur. Behalten Sie die Kontrolle.

Erhalten Sie sofort Zugriff, ohne Kreditkarte und Wartezeit. Bilden Sie die Arbeitsweise Ihrer Organisation in klaren, vernetzten Prozessmodellen ab.

Entwickeln Sie Ihre Prozessarchitektur, definieren Sie Zuständigkeiten und Kontrollen und stimmen Sie Rollen und Verantwortlichkeiten auf allen Ebenen ab.

Starten Sie Ihre kostenlose Testphase und schaffen Sie eine verlässliche Grundlage, um Ihre Prozesse zu steuern und kontinuierlich zu verbessern.

Starten Sie Ihre kostenlose Testphase