Saltar a contenido

Búsqueda, favoritos e identidad

Tres grupos pequeños que todo cliente necesita: encontrar cosas, fijar procesos y saber quién está llamando.

Búsqueda global

POST /search
POST /search/global

Ambas rutas ejecutan la misma búsqueda; search/global es el nombre que usan las pantallas nuevas.

Campo Significado
q Qué buscar. Menos de dos caracteres devuelve un resultado vacío, no todo
segment home, designer o admin; vacío busca en los tres
limit Resultados por grupo, de 1 a 50 (10 por defecto)

La respuesta lleva la consulta, un total y una entrada por segmento con su count y sus items:

{"success": true, "query": "invoice", "total": 3,
 "segments": {"home": {"count": 2, "items": […]}, "designer": {"count": 1, "items": […]},
              "admin": {"count": 0, "items": []}}}

Favoritos

Los favoritos son los procesos que un usuario fijó para iniciarlos rápido. Pertenecen al usuario, no al proceso.

Ruta Campos Efecto
favorites/list — Los favoritos del llamador
favorites/save pro_uid, tas_uid Fija un proceso, o actualiza la tarea fijada
favorites/delete id, tas_uid Lo quita
favorites/launch pro_uid, tas_uid Inicia un caso y devuelve su APPLICATION e INDEX

Las cuatro resuelven el usuario desde la sesión o desde el token; ninguna recibe un identificador de usuario. Es deliberado: un cliente no puede fijar un favorito para otra persona.

favorites/list devuelve las filas bajo favorites, no bajo data.

Usuario actual

POST /admin/me

Sin campos. Devuelve la identidad a la que pertenece el token:

{"user": {"uid": "…", "username": "admin", "fullname": "Administrator admin"},
 "workspace": "starter",
 "role": "LURANA_ADMIN",
 "groups": [{"uid": "…", "name": "LURANA_ADMIN"}],
 "permissions": ["DASHBOARDS", "…"]}

Es la forma más barata de comprobar un token antes de una operación larga, y la forma en que un cliente decide qué pantallas mostrar: permissions es la lista que usa la interfaz para ocultar lo que el usuario no puede hacer.

Aprovisionamiento de usuarios y descubrimiento de procesos

La referencia también lista las llamadas que necesita una integración para gestionar usuarios y para saber qué se puede iniciar:

Grupo Rutas
Descubrimiento de procesos admin/processes/list — los procesos del espacio
Aprovisionamiento de usuarios admin/users/list, get, search, save, status, test-username, form-options, más roles-list, groups-list y departments-list para llenar el formulario

Son las mismas llamadas que hace la pantalla de administración, así que requieren un rol de administrador. Están en la referencia de endpoints con su acción de controlador; las páginas de administración describen los campos.

Relacionado