Skip to content

Search, favorites and identity

Three small groups that every client needs: finding things, pinning processes, and knowing who is calling.

POST /search
POST /search/global

Both routes run the same search; search/global is the name the newer screens use.

Field Meaning
q What to look for. Shorter than two characters returns an empty result, not everything
segment home, designer or admin; empty searches all three
limit Results per group, 1 to 50 (10 by default)

The answer carries the query, a total, and one entry per segment with a count and its items:

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

Favorites

Favorites are the processes a user pinned to start them quickly. They belong to the user, not to the process.

Route Fields Effect
favorites/list — The favorites of the caller
favorites/save pro_uid, tas_uid Pins a process, or updates the pinned task
favorites/delete id, tas_uid Removes it
favorites/launch pro_uid, tas_uid Starts a case and returns its APPLICATION and INDEX

All four resolve the user from the session or from the token; none of them takes a user id. That is deliberate: a client cannot pin a favorite for someone else.

favorites/list returns the rows under favorites, not under data.

Current user

POST /admin/me

No fields. Returns the identity the token belongs to:

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

It is the cheapest way to check a token before a long operation, and the way a client decides which screens to show: permissions is the list the interface uses to hide what the user cannot do.

User provisioning and process discovery

The reference also lists the calls an integration needs to manage users and to know what can be started:

Group Routes
Process discovery admin/processes/list — the processes of the workspace
User provisioning admin/users/list, get, search, save, status, test-username, form-options, plus the roles-list, groups-list and departments-list needed to fill the form

These are the same calls the admin screen makes, so they need an administrator role. They are listed in the endpoint reference with their controller actions; the admin pages describe the fields.