Skip to content
aimrack

Process

The process resource.

Base/process
GET/process

List processes

Retrieve a paginated list of processes. Filter, order, and select columns with PostgREST query parameters.

Query parameters

selectstring

Comma-separated columns to return. Defaults to all.

orderstring

Column to sort by, e.g. `createdAt.desc`.

limitinteger

Maximum rows to return.

offsetinteger

Rows to skip, for pagination.

GET/process
curl --request GET \
  --url '<your-host>/process?select=*&limit=10' \
  --header 'Authorization: Bearer <api-key>'
Response
[
  {
    "id": "abc123def456",
    "name": "Example",
    "defaultStandardFactor": "string",
    "companyId": "xyz789",
    "createdBy": "string",
    "createdAt": "2026-01-01T00:00:00Z",
    "processType": "string",
    "completeAllOnScan": true
  }
]
GET/process

Retrieve a process

Fetch a single process by filtering on `id`.

Query parameters

idstring

Match on the process's `id`, e.g. `eq.{id}`.

GET/process
curl --request GET \
  --url '<your-host>/process?id=eq.%7Bid%7D' \
  --header 'Authorization: Bearer <api-key>'
Response
{
  "id": "abc123def456",
  "name": "Example",
  "defaultStandardFactor": "string",
  "companyId": "xyz789",
  "createdBy": "string",
  "createdAt": "2026-01-01T00:00:00Z",
  "processType": "string",
  "completeAllOnScan": true
}
POST/process

Create a process

Create a new process.

Body parameters

namestringrequired
defaultStandardFactorstringrequired
companyIdstringrequired

References company.id

customFieldsobject
processTypeoperationTyperequired
tagsarray
completeAllOnScanbooleanrequired
activebooleanrequired
requiresAbilitybooleanrequired
batchablebooleanrequired
batchTypebatchTyperequired
batchRulesobject

Per-dimension batch compatibility levels (must|guide|ignore); NULL = defaults (substance/grade/dimension guide, form/finish/item ignore).

POST/process
curl --request POST \
  --url <your-host>/process \
  --header 'Authorization: Bearer <api-key>' \
  --header 'Content-Type: application/json' \
  --header 'Prefer: return=representation' \
  --data '{"name":"Example","defaultStandardFactor":"string","companyId":"xyz789","processType":"string","completeAllOnScan":true,"active":true,"requiresAbility":true,"batchable":true,"batchType":"string"}'
Response
{
  "id": "abc123def456",
  "name": "Example",
  "defaultStandardFactor": "string",
  "companyId": "xyz789",
  "createdBy": "string",
  "createdAt": "2026-01-01T00:00:00Z",
  "processType": "string",
  "completeAllOnScan": true
}
PATCH/process

Update a process

Update an existing process, matched on `id`.

Body parameters

namestringrequired
defaultStandardFactorstringrequired
companyIdstringrequired

References company.id

customFieldsobject
processTypeoperationTyperequired
tagsarray
completeAllOnScanbooleanrequired
activebooleanrequired
requiresAbilitybooleanrequired
batchablebooleanrequired
batchTypebatchTyperequired
batchRulesobject

Per-dimension batch compatibility levels (must|guide|ignore); NULL = defaults (substance/grade/dimension guide, form/finish/item ignore).

PATCH/process
curl --request PATCH \
  --url '<your-host>/process?id=eq.%7Bid%7D' \
  --header 'Authorization: Bearer <api-key>' \
  --header 'Content-Type: application/json' \
  --header 'Prefer: return=representation' \
  --data '{"name":"Example"}'
Response
{
  "id": "abc123def456",
  "name": "Example",
  "defaultStandardFactor": "string",
  "companyId": "xyz789",
  "createdBy": "string",
  "createdAt": "2026-01-01T00:00:00Z",
  "processType": "string",
  "completeAllOnScan": true
}
DELETE/process

Delete a process

Delete a process, matched on `id`. Returns 204 No Content.

Query parameters

idstring

The `id` of the process to delete, e.g. `eq.{id}`.

DELETE/process
curl --request DELETE \
  --url '<your-host>/process?id=eq.%7Bid%7D' \
  --header 'Authorization: Bearer <api-key>'
204 No Content