Ezen az oldalon
> erőforrások > dokumentáció > api > API referencia: keresés

API-referencia: keresés

A keresési végpont globális (szemantikus) keresést végez a bérlő tartalmai között. Saját munkaterületén is kipróbálhatja a próbaverzióval.

Globális keresés a bérlő szerepkörei, folyamatai, elemei, dokumentációja, verziói és megjegyzései között

A kérések száma bérlőnként korlátozott; a 429-es válasz a közös üzenettörzset tartalmazza ({“message”: “Too many search requests, please slow down.”}).

Végpont: POST /v1/tenant/{tenantId}/search

Hitelesítés: Bérlőhöz kötött API-kulcs · read hatókör

Paraméterek:

Név Típus Hely Kötelező Leírás
tenantId string útvonal Igen Formátum: uuid

Kérés törzse:

{
	"query": "string",
	"mode": "semantic",
	"categories": [
		"role"
	],
	"processId": "00000000-0000-0000-0000-000000000000",
	"k": 0
}
Mező Típus Kötelező Leírás
query string Igen Keresési lekérdezés
Maximális hossz: 1000
mode semantic | exact | hybrid Nem semantic = beágyazások, exact = szó szerinti, hybrid = mindkettő
Engedélyezett értékek: semantic, exact, hybrid
Alapértelmezett: hybrid
categories role | process | element | documentation | version | comment[] Nem Az eredmények szűkítése ezekre a kategóriákra
processId string Nem Az eredmények szűkítése egyetlen folyamatra
Formátum: uuid
k integer Nem Visszaadandó találatok száma
Alapértelmezett: 20
Minimum: 1
Maximum: 50

Válasz (200):

Keresési eredmények (találatok, darabszámok, összesen, javaslatok)

{
	"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"
	]
}
Mező Típus Kötelező Leírás
hits object[] Igen
counts object Igen
total number Igen
suggestions string[] Igen

Hibák:

  • 401 Hiányzó, érvénytelen, letiltott vagy lejárt API-kulcs
  • 429 Túllépte a sebességkorlátot: tekintse meg a végpont dokumentált korlátozását

Kapcsolódó dokumentáció

Tervezzen jobb folyamatokat. Építsen összekapcsolt architektúrát. Tartsa kézben a működést.

Azonnal hozzáférhet, bankkártya és várakozás nélkül. Alakítsa szervezete működését világos, összekapcsolt folyamatmodellekké.

Építse fel folyamatarchitektúráját, határozza meg a felelősségi köröket és az ellenőrzéseket, és hangolja össze a szerepeket minden szinten.

Indítsa el az ingyenes próbaverziót, és teremtsen megbízható alapot folyamatainak irányításához, kezeléséhez és folyamatos fejlesztéséhez.

Indítsa el ingyenes próbaverzióját