MyJackfruit

Help
Browse topics · Using GilbApp

Using GilbApp

← Using GilbApp

How do I read a process's steps?

Short answer

List the vault's processes, then read one with its steps, which come in order from step 1.

Before you start

Your app holds a person's sign-in token.

Words used here (3)
sign-in token
A sign-in token is the credential GilbPlatform issues when a person signs in; your app presents it, with a proof, on each request.
entry condition
An entry condition is something that must be true before a process may start; a process starts only when its entry conditions hold.
exit condition
An exit condition is what must be true before a process may finish; when it is true, the process hands back.
Steps
  1. List the vault's processes.

    Ask for the processes the person may read in a vault, with the person's token:
    GET https://<name>.gilb.com/lws/vault/<vault id, encoded>/processes

    More about this

    A process is a standard that holds work, with entry conditions, steps and exit conditions. The answer has processes, each as a single read gives it, with its @id; total, the number the person may read; returnedProcesses; and complete. A page holds 20 unless you set limit, up to 200; with an offset above 0, complete is never true, so read up to 200 in one page. A process the person may not read is left out, and a vault they may not read answers 403 vault target denied. Encoded means written with encodeURIComponent, so the address fits in one part of the path. The token goes in Authorization: DPoP with a new DPoP proof (a short signed note your app makes for one request, naming its method and address), or as a plain Bearer token (the token alone, with no proof): /lws, /files and many /base routes take it.

  2. Read one process with its steps.

    Take the last part of the process's @id as its id, and ask the vault's host for it with its steps:
    GET https://<vault host>/lws/process/<id>/steps?limit=200

    More about this

    The answer has process, the process itself; steps, in order of stepOrder; totalSteps, returnedSteps and complete. Each step has instruction, the text of the step; stepOrder, its place from 1; processOf, its process; and, where set, entryCondition and exitCondition, what must hold to start and to finish it, and handsOffTo, the process it hands on to. A step the person may not read is left out; a process they may not read, or that is not there, answers 404 No LWS process at .... Checked on production on 2026-11-11, with no token: https://appbuilder.gilb.com/lws/process/06gqw6jdn9sgbc9rfbfrwc7rec/steps answered 200, 8 steps, complete true.

Deeper

Give every step an a:stepOrder: a step with none comes last in the steps list.

Source: GilbPlatform 498d29a0 (live at https://id.gilb.com/version, read 2026-11-11; code read at 498d29a0): src/lws/routes.ts:751-759 (GET /lws/vault/:vaultId/processes: vaultTarget, getProcesses), :790-802 (GET /lws/process/:id/steps); src/lws/processes.ts:1-60, :120-150 (every readable t:Process, framed like the single read; total, returnedProcesses, complete, pageSize, processes; an unreadable one omitted); src/lws/standard-family-page.ts:72 (max 200), :118 (default 20), :180-196 (complete only at offset 0); src/lws/process-steps.ts:1-30 (steps = reverse a:processOf, each framed as GET /lws/r/<step>, ordered by a:stepOrder; instruction, handsOffTo), :60-75 (404 No LWS process at ...), :80-225 (404 for absent, unreadable or deleted; each step re-authorized; totalSteps, returnedSteps, complete, pageSize, steps); src/lws/document-units.ts:20, :44, :57, :158-161 (an ordinal that is not a number sorts last; re-read 2026-11-12); src/process/vocab.ts (a:processOf, a:stepOrder, a:entryCondition, a:exitCondition, a:instruction, a:handsOffTo). Public reads, no token, 2026-11-11: https://appbuilder.gilb.com/lws/process/06gqw6jdn9sgbc9rfbfrwc7rec/steps 200 (process t:Process Dev.Guide.AppAccess, totalSteps 8, returnedSteps 8, complete true, pageSize 20; step keys instruction, processOf, stepOrder, unitTag, handsOffTo on one); https://appbuilder.gilb.com/lws/vault/https%3A%2F%2Fappbuilder.gilb.com%2Fbase/processes 403 vault target denied; the same for kaizen.gilb.com. GilbVeda (public read /base/terms?q=, 2026-11-11): t:StepOrder (Approved), t:EntryCondition (Approved), t:ProcessOf (Approved). No POST was sent (public GETs only). Row: GilbPlatform.ProcessStepsRead. Cut to the read half on 2026-11-12: moving a process on is held.

For developers

curl

process-steps.sh

# Read a process with its steps. The Developer Guide's own processes need no token.
curl -s "https://appbuilder.gilb.com/lws/process/06gqw6jdn9sgbc9rfbfrwc7rec/steps?limit=200"
# 200 {"process":{...},"totalSteps":8,"returnedSteps":8,"complete":true,"pageSize":200,"steps":[
#        {"@id":"...","@type":"t:ProcessStep","instruction":"...","processOf":{"@id":"..."},"stepOrder":1, ...}, ...]}

Checked against GilbApp d529620.