x-cpod-domain: process
Process
Process flow definitions, bottleneck identification, and efficiency scoring for workflow optimization.
Try in explorer
client.process.maps · client.process.bottlenecks · client.process.efficiencyScoresProcessMap
A process flow definition with steps and transitions.
REST path
/api/v1/process/mapsOperations
listgetcreateupdatedeleteSDK
// list — returns only your records; add filters/search:
await client.process.maps.maps.list()
// create:
await client.process.maps.maps.create({
name: "example name",
id: "rec_01HXEXAMPLE",
description: "example description",
owner_id: "rec_01HXEXAMPLE",
status: "draft",
})| Field | Type | Description |
|---|---|---|
| id | uuid | — |
| name* | string | — |
| description | string | — |
| steps | json | — |
| owner_id | uuid | — |
| status | enum | —draftactivearchived |
Bottleneck
An identified bottleneck or delay in a process.
REST path
/api/v1/process/bottlenecksOperations
listgetcreateupdatedeleteSDK
// list — returns only your records; add filters/search:
await client.process.maps.bottlenecks.list()
// create:
await client.process.maps.bottlenecks.create({
id: "rec_01HXEXAMPLE",
process_map_id: "processmap_01HXEXAMPLE",
step_id: "example step_id",
severity: "low",
description: "example description",
detected_at: "2026-01-01T00:00:00Z",
})| Field | Type | Description |
|---|---|---|
| id | uuid | — |
| process_map_id | uuid→ProcessMap | — |
| step_id | string | — |
| severity | enum | —lowmediumhighcritical |
| description | string | — |
| detected_at | date-time | — |
EfficiencyScore
Efficiency scoring for a process or step.
REST path
/api/v1/process/efficiency-scoresOperations
listgetcreateSDK
// list — returns only your records; add filters/search:
await client.process.maps.efficiencyScores.list()
// create:
await client.process.maps.efficiencyScores.create({
id: "rec_01HXEXAMPLE",
process_map_id: "processmap_01HXEXAMPLE",
score: 42,
period: "example period",
})| Field | Type | Description |
|---|---|---|
| id | uuid | — |
| process_map_id | uuid→ProcessMap | — |
| score | number | — |
| period | string | — |
| factors | json | — |