Referencia de la API: búsqueda

El endpoint de búsqueda realiza una búsqueda global (semántica) en el contenido del inquilino. Puede probarlo en su propio espacio de trabajo con una prueba gratuita.

Búsqueda global en los roles, procesos, elementos, documentación, versiones y comentarios del inquilino

Límite de solicitudes por inquilino; una respuesta 429 incluye el cuerpo de mensaje compartido ({“message”: “Too many search requests, please slow down.”}).

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

Autenticación: Clave de API asociada al inquilino · read ámbito

Parámetros:

Nombre	Tipo	Ubicación	Obligatorio	Descripción
tenantId	string	ruta	Sí	Formato: `uuid`

Cuerpo de la solicitud:

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

Campo	Tipo	Obligatorio	Descripción
query	string	Sí	Consulta de búsqueda Longitud máxima: 1000
mode	`semantic` \| `exact` \| `hybrid`	No	semantic = embeddings, exact = literal, hybrid = ambos Valores permitidos: `semantic`, `exact`, `hybrid` Valor predeterminado: `hybrid`
categories	`role` \| `process` \| `element` \| `documentation` \| `version` \| `comment`[]	No	Limita los resultados a estas categorías
processId	string	No	Limita los resultados a un solo proceso Formato: `uuid`
k	integer	No	Número de resultados que se devolverán Valor predeterminado: `20` Mínimo: 1 Máximo: 50

Respuesta (200):

Resultados de búsqueda (coincidencias, recuentos, total, sugerencias)

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

Campo	Tipo	Obligatorio
hits	object[]	Sí
counts	object	Sí
total	number	Sí
suggestions	string[]	Sí

Errores:

401 Falta la clave de API, no es válida, está deshabilitada o ha caducado
429 Se ha alcanzado el límite de solicitudes: consulte el límite documentado para este endpoint

Documentación relacionada

Referencia de API: organizaciones

Referencia de API para los endpoints de gestión de organizaciones y administración de usuarios.

Referencia de la API: inquilinos

Referencia de la API para los endpoints de gestión de inquilinos y control de acceso de usuarios.

Referencia de la API: datos

Referencia de la API para los endpoints de administración de conjuntos de datos y tablas de datos.

Referencia de la API: procesos

Referencia de la API para los endpoints de gestión de procesos y mapeo de datos.

Diseñe mejores procesos. Conecte su arquitectura. Mantenga el control.

Acceda de inmediato, sin tarjeta de crédito ni esperas. Transforme la forma de trabajar de su organización en diseños de procesos claros y conectados.

Defina la arquitectura de procesos, los responsables y los controles, y alinee las funciones y responsabilidades en todos los niveles.

Comience su prueba gratuita y establezca una base fiable para gobernar, gestionar y mejorar continuamente sus procesos.

Comience hoy su prueba gratuita