API-referentie: zoeken

Het zoekendpoint voert een globale (semantische) zoekopdracht uit in de inhoud van de tenant. Met een gratis proefperiode kun je het uitproberen in je eigen workspace.

Globaal zoeken in rollen, processen, elementen, documentatie, versies en opmerkingen van de tenant

De limiet geldt per tenant. Een 429-response bevat de gedeelde berichttekst ({“message”: “Too many search requests, please slow down.”}).

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

Authenticatie: API-sleutel voor deze tenant · read-scope

Parameters:

Requestbody:

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

Response (200):

Zoekresultaten (treffers, aantallen, totaal, suggesties)

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

Fouten:

• 401 API-sleutel ontbreekt, is ongeldig, uitgeschakeld of verlopen
• 429 Verzoeklimiet bereikt: raadpleeg de gedocumenteerde limiet van het endpoint