Carbon

Workflow Version

The workflow version resource.

Basehttps://rest.carbon.ms/workflowVersion
GET/workflowVersion

List workflow versions

Retrieve a paginated list of workflow versions. 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.

GEThttps://rest.carbon.ms/workflowVersion
curl --request GET \
  --url 'https://rest.carbon.ms/workflowVersion?select=*&limit=10' \
  --header 'Authorization: Bearer <api-key>'
Response
[
  {
    "id": "abc123def456",
    "companyId": "xyz789",
    "workflowId": "xyz789",
    "versionNumber": 0,
    "formatVersion": 0,
    "nodes": "string",
    "edges": "string",
    "createdBy": "string"
  }
]
GET/workflowVersion

Retrieve a workflow version

Fetch a single workflow version by filtering on `id`.

Query parameters

idstring

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

GEThttps://rest.carbon.ms/workflowVersion
curl --request GET \
  --url 'https://rest.carbon.ms/workflowVersion?id=eq.%7Bid%7D' \
  --header 'Authorization: Bearer <api-key>'
Response
{
  "id": "abc123def456",
  "companyId": "xyz789",
  "workflowId": "xyz789",
  "versionNumber": 0,
  "formatVersion": 0,
  "nodes": "string",
  "edges": "string",
  "createdBy": "string"
}
POST/workflowVersion

Create a workflow version

Create a new workflow version.

Body parameters

workflowIdstringrequired
versionNumbernumberrequired
formatVersionnumberrequired
nodesobjectrequired
edgesobjectrequired
POSThttps://rest.carbon.ms/workflowVersion
curl --request POST \
  --url https://rest.carbon.ms/workflowVersion \
  --header 'Authorization: Bearer <api-key>' \
  --header 'Content-Type: application/json' \
  --header 'Prefer: return=representation' \
  --data '{"workflowId":"xyz789","versionNumber":0,"formatVersion":0,"nodes":"string","edges":"string"}'
Response
{
  "id": "abc123def456",
  "companyId": "xyz789",
  "workflowId": "xyz789",
  "versionNumber": 0,
  "formatVersion": 0,
  "nodes": "string",
  "edges": "string",
  "createdBy": "string"
}
PATCH/workflowVersion

Update a workflow version

Update an existing workflow version, matched on `id`.

Body parameters

workflowIdstringrequired
versionNumbernumberrequired
formatVersionnumberrequired
nodesobjectrequired
edgesobjectrequired
PATCHhttps://rest.carbon.ms/workflowVersion
curl --request PATCH \
  --url 'https://rest.carbon.ms/workflowVersion?id=eq.%7Bid%7D' \
  --header 'Authorization: Bearer <api-key>' \
  --header 'Content-Type: application/json' \
  --header 'Prefer: return=representation' \
  --data '{"workflowId":"xyz789"}'
Response
{
  "id": "abc123def456",
  "companyId": "xyz789",
  "workflowId": "xyz789",
  "versionNumber": 0,
  "formatVersion": 0,
  "nodes": "string",
  "edges": "string",
  "createdBy": "string"
}
DELETE/workflowVersion

Delete a workflow version

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

Query parameters

idstring

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

DELETEhttps://rest.carbon.ms/workflowVersion
curl --request DELETE \
  --url 'https://rest.carbon.ms/workflowVersion?id=eq.%7Bid%7D' \
  --header 'Authorization: Bearer <api-key>'
204 No Content