Skip to content
StartupBuilder
by startups.studio
by Startups.Studio
Code
Changelog
APICore grammarProcess

Process routes: create, get, list

The Process Verbs create, get, list as api.sb routes, with inputs, result, refusals and an example.

Reference for Process, one group of Process routes.

Process.create

Creates a Process. Verb page.

Text
POST /{namespace}/processes

Body, as JSON: the inputs. Emits Process.created.

Inputs

InputTypeRequiredDescription
namestringrequiredThe name in sentence case, such as Month-end close.
saystext[]What a founder says to run, turn on, or ask about it.
settingsjsonThe Settings it reads: key, type, default, the founder’s sentence and the Verb that sets each.
defaultOnstring[]The Product Templates it is on in by default.
wakesjsonThe Events that wake it in the Startup’s own records.
inputsstring[]The Nouns an Action reads at its start.
outputsstring[]The Nouns a finished Action leaves behind, rolled up from its Workflows.
outcometextWhat a finished Action leaves true, in one sentence.
serviceLeveljsonIts target duration, clock, escalation Role, and the waits that stop the clock.
scopestringWhere it runs: startup, studio, or any.
playPlayA Process runs the steps of a Play each time the Startup runs it.

Returns

OutputTypeRequiredDescription
processProcessrequiredThe Process.

Refuses when

CheckErrorFixThen call
The key is valid, but its scopes do not allow this operation.forbiddenUse a key whose scopes cover the operation, or ask an owner of the namespace to grant them.None.

Example

Terminal
curl -X POST https://api.sb/leaseline.app/processes \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"name":"Leaseline"}'
JSON
{
  "api": "https://api.sb/leaseline.app",
  "process": {
    "$id": "https://api.sb/leaseline.app/processes/process_X2zteZ3CQI",
    "$type": "Process",
    "name": "Leaseline"
  },
  "action": {
    "$id": "https://api.sb/leaseline.app/actions/act_br07HsG8MG",
    "operation": "Process.create",
    "status": "done"
  },
  "links": {
    "self": "https://api.sb/leaseline.app/actions/act_br07HsG8MG"
  }
}

Process.get

Returns one Process by id. Verb page.

Text
GET /{namespace}/processes/{id}

Path: id. Query: the other inputs. Reads only: it emits no Event.

Inputs

InputTypeRequiredDescription
idstringrequiredThe id of the Process.
atstringA time or Version name: the record as it stood then. Unset: as it stands now.

Returns

OutputTypeRequiredDescription
processProcessrequiredThe Process.

Refuses when

CheckErrorFixThen call
The key is valid, but its scopes do not allow this operation.forbiddenUse a key whose scopes cover the operation, or ask an owner of the namespace to grant them.None.

Example

Terminal
curl https://api.sb/leaseline.app/processes/process_X2zteZ3CQI \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY"
JSON
{
  "api": "https://api.sb/leaseline.app",
  "$type": "Process",
  "$id": "https://api.sb/leaseline.app/processes/process_X2zteZ3CQI",
  "process": {
    "$id": "https://api.sb/leaseline.app/processes/process_X2zteZ3CQI",
    "$type": "Process",
    "name": "Leaseline"
  },
  "links": {
    "self": "https://api.sb/leaseline.app/processes/process_X2zteZ3CQI",
    "up": "https://api.sb/leaseline.app/processes"
  },
  "actions": {
    "enable": "https://api.sb/leaseline.app/processes/process_X2zteZ3CQI/enable",
    "pause": "https://api.sb/leaseline.app/processes/process_X2zteZ3CQI/pause"
  }
}

Process.list

Returns Processes, newest first, one page at a time. Verb page.

Text
GET /{namespace}/processes

Query: the inputs. Reads only: it emits no Event.

Inputs

InputTypeRequiredDescription
limitintegerAt most this many records, up to 100. The default is 20.
afterstringThe cursor from the previous page.
wherestringA filter over the properties, such as paidAt = null and total.amount > 500.
sortstringProperties to sort by, comma-separated; a leading minus sorts descending.
totalbooleanTrue adds the match count as meta.total, exact up to 10,000 matches and estimated above.
facetsstringProperties to count by value, comma-separated, returned as meta.facets.
fieldsstringProperties to return on each record, comma-separated; $id and $type always return.
includestringRelated records to embed in place of their URLs, comma-separated.
depthintegerHow many levels of related records to embed. The default is 1.
qstringWords to match across the text properties, ranked by relevance.
matchstringRanks the search by words, or meaning; words is the default.

Returns

OutputTypeRequiredDescription
processeslist of ProcessrequiredOne page of Processes.

Refuses when

CheckErrorFixThen call
The key is valid, but its scopes do not allow this operation.forbiddenUse a key whose scopes cover the operation, or ask an owner of the namespace to grant them.None.

Example

Terminal
curl "https://api.sb/leaseline.app/processes?limit=20" \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY"
JSON
{
  "api": "https://api.sb/leaseline.app",
  "$type": "Process",
  "processes": [
    {
      "$id": "https://api.sb/leaseline.app/processes/process_X2zteZ3CQI",
      "$type": "Process",
      "name": "Leaseline"
    }
  ],
  "meta": {
    "limit": 20,
    "after": "process_X2zteZ3CQI"
  },
  "links": {
    "self": "https://api.sb/leaseline.app/processes?limit=20",
    "next": "https://api.sb/leaseline.app/processes?after=process_X2zteZ3CQI"
  }
}

Process

Previous

update, delete

Next