Referenční příručka API: vyhledávání

Endpoint vyhledávání provádí globální sémantické vyhledávání v obsahu tenanta. Můžete si ho vyzkoušet ve vlastním pracovním prostoru se zkušební verzí.

Globální vyhledávání v rolích, procesech, prvcích, dokumentaci, verzích a komentářích tenanta

Počet požadavků je omezen pro každého tenanta. Odpověď 429 obsahuje společné tělo zprávy ({“message”: “Too many search requests, please slow down.”}).

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

Ověření: API klíč pro konkrétního tenanta · rozsah read

Parametry:

Tělo požadavku:

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

Odpověď (200):

Výsledky vyhledávání (shody, počty, celkový počet, návrhy)

{
	"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"
	]
}

Chyby:

• 401 Chybějící, neplatný, deaktivovaný nebo prošlý API klíč
• 429 Překročen limit požadavků: viz dokumentovaný limit endpointu