API docs by Redocly

go-bpmn HTTP API (v0.3.0)

Download OpenAPI specification:

URL: https://github.com/gclaussn/go-bpmn/issues License: MIT

API to interact with a process engine via HTTP.

Elements

An element represents a BPMN element of a process.

Query elements

Performs an element query.

Authorizations:
ApiKeyAuth
query Parameters
offset
integer <int32>

The number of results to skip, before returning any result. If offset is 0, no results are skipped.

limit
integer <int32>

Maximum number of results to return. If limit is 0, all results are returned.

Request Body schema: application/json
processId
integer <int32>

Process filter.

bpmnElementId
string

BPMN element ID filter.

Responses

Request samples

Content type
application/json
{
  • "processId": 0,
  • "bpmnElementId": "string"
}

Response samples

Content type
application/json
{
  • "count": 4,
  • "results": [
    ]
}

Element instances

An element instance is an instance of a BPMN element in the scope of an process instance.

Query element instances

Performs an element instance query.

Authorizations:
ApiKeyAuth
query Parameters
offset
integer <int32>

The number of results to skip, before returning any result. If offset is 0, no results are skipped.

limit
integer <int32>

Maximum number of results to return. If limit is 0, all results are returned.

Request Body schema: application/json
partition
string <date>

Partition filter.

id
integer <int32>

Element instance filter.

processId
integer <int32>

Process filter.

processInstanceId
integer <int32>

Process instance filter.

bpmnElementId
string

BPMN element ID filter.

states
Array of strings (InstanceState) <= 7 items unique
Items Enum: "CANCELED" "COMPLETED" "CREATED" "QUEUED" "STARTED" "SUSPENDED" "TERMINATED"

States to include.

Responses

Request samples

Content type
application/json
{
  • "partition": "2025-05-01",
  • "processInstanceId": 576
}

Response samples

Content type
application/json
{
  • "count": 3,
  • "results": [
    ]
}

Get element variables

Gets variables of an active or ended element instance.

Authorizations:
ApiKeyAuth
path Parameters
partition
required
string <date>

Element instance partition.

id
required
integer <int32>

Element instance ID.

query Parameters
names
string
Examples: names=a,b,c

Comma separated list of variables to include.

Responses

Response samples

Content type
application/json
{
  • "count": 2,
  • "variables": [
    ]
}

Set element variables

Sets or deletes variables of an active element instance.

Authorizations:
ApiKeyAuth
path Parameters
partition
required
string <date>

Element instance partition.

id
required
integer <int32>

Element instance ID.

Request Body schema: application/json
Array of objects (VariableData) <= 100 items

Variables to set or delete. For a variable deletion, no data must be provided.

workerId
required
string

ID of the worker that set the variables.

Responses

Request samples

Content type
application/json
Example
{
  • "variables": {
    },
  • "workerId": "go-bpmn"
}

Response samples

Content type
application/problem+json
{
  • "status": 400,
  • "type": "HTTP_REQUEST_BODY",
  • "title": "invalid request body",
  • "detail": "failed to validate request body",
  • "errors": [
    ]
}

Events

Send message

Sends a message to notify a message subscriber or to buffer the message.

A subscriber can be a message start, boundary or catch event. In case of a message start event, a new process instance is created. In case of a message boundary or catch event, an existing process instance is continued.

Authorizations:
ApiKeyAuth
Request Body schema: application/json
correlationKey
required
string

Key, used to correlate a message subscription with the message.

object (Timer)

A timer defines a point in time using a time value, a CRON expression or a duration.

name
required
string

Message name.

uniqueKey
string

Optional key that uniquely identifies the message. If a message with the same name, correlation key and unique key already exists, the message is discarded.

Array of objects (VariableData) <= 100 items

Variables to set or delete at process instance scope. For a variable deletion, no data must be provided.

workerId
required
string

ID of the worker that sent the message.

Responses

Request samples

Content type
application/json
{
  • "correlationKey": "example-key",
  • "expirationTimer": {
    },
  • "name": "example-message",
  • "variables": [
    ],
  • "workerId": "go-bpmn"
}

Response samples

Content type
application/json
{
  • "id": 9,
  • "correlationKey": "example-key",
  • "createdAt": "2025-05-01T17:44:19.997Z",
  • "createdBy": "go-bpmn",
  • "expiresAt": "2025-05-01T18:44:19.997Z",
  • "correlated": false,
  • "name": "example-message"
}

Query messages

Performs a message query.

Authorizations:
ApiKeyAuth
query Parameters
offset
integer <int32>

The number of results to skip, before returning any result. If offset is 0, no results are skipped.

limit
integer <int32>

Maximum number of results to return. If limit is 0, all results are returned.

Request Body schema: application/json
id
integer <int64>

Message filter.

excludeExpired
boolean

Determines if expired messages are returned.

name
string

Message name filter.

Responses

Request samples

Content type
application/json
{
  • "id": 0,
  • "excludeExpired": true,
  • "name": "string"
}

Response samples

Content type
application/json
{
  • "count": 1,
  • "results": [
    ]
}

Send signal

Sends a signal to notify signal subscribers.

A subscriber can be a signal start or catch event. In case of a signal start event, a new process instance is created. In case of a signal boundary or catch event, an existing process instance is continued.

Authorizations:
ApiKeyAuth
Request Body schema: application/json
name
required
string

Signal name.

Array of objects (VariableData) <= 100 items

Variables to set or delete at process instance scope. For a variable deletion, no data must be provided.

workerId
required
string

ID of the worker that sent the signal.

Responses

Request samples

Content type
application/json
{
  • "name": "example-signal",
  • "variables": [
    ],
  • "workerId": "go-bpmn"
}

Response samples

Content type
application/json
{
  • "id": 9,
  • "createdAt": "2025-05-01T17:44:19.997Z",
  • "createdBy": "go-bpmn",
  • "name": "example-signal",
  • "subscriberCount": 3
}

Incidents

An incident represents a failed job or task, which has no more retries left. An incident is related to either a job or a task.

Query incidents

Performs an incident query.

Authorizations:
ApiKeyAuth
query Parameters
offset
integer <int32>

The number of results to skip, before returning any result. If offset is 0, no results are skipped.

limit
integer <int32>

Maximum number of results to return. If limit is 0, all results are returned.

Request Body schema: application/json
partition
string <date>

Partition filter.

id
integer <int32>

Incident filter.

jobId
integer <int32>

Job filter.

processInstanceId
integer <int32>

Process instance filter.

taskId
integer <int32>

Process filter.

Responses

Request samples

Content type
application/json
{
  • "partition": "2019-08-24",
  • "id": 0,
  • "jobId": 0,
  • "processInstanceId": 0,
  • "taskId": 0
}

Response samples

Content type
application/json
{
  • "count": 1,
  • "results": [
    ]
}

Resolve incident

Resolves a job or task related incident.

When an incident is resolved, a retry job or task is created. The retry count is set to 0.

Authorizations:
ApiKeyAuth
path Parameters
partition
required
string <date>

Incident partition.

id
required
integer <int32>

Incident ID.

Request Body schema: application/json
retryTimer
string

Duration until the retry job or task becomes due.

workerId
required
string

ID of the worker that resolved the incident

Responses

Request samples

Content type
application/json
{
  • "workerId": "go-bpmn"
}

Response samples

Content type
application/problem+json
{
  • "status": 400,
  • "type": "HTTP_REQUEST_BODY",
  • "title": "invalid request body",
  • "detail": "failed to validate request body",
  • "errors": [
    ]
}

Jobs

A job is a unit of work related to an element instance, which must be locked, executed and completed by a worker.

Lock jobs

Locks due jobs, which match the specified conditions.

Authorizations:
ApiKeyAuth
Request Body schema: application/json
partition
string <date>

Partition condition.

id
integer <int32>

Job condition - must be used in combination with a partition.

processIds
Array of integers <int32> <= 100 items unique [ items <int32 > ]

IDs of processes to include.

processInstanceId
integer <int32>

Process instance condition - must be used in combination with a partition.

limit
integer <int32> [ 1 .. 1000 ]

Maximum number of jobs to lock.

workerId
required
string

ID of the worker that locks the jobs.

Responses

Request samples

Content type
application/json
{
  • "partition": "2025-05-01",
  • "processIds": [
    ],
  • "limit": 1,
  • "workerId": "go-bpmn"
}

Response samples

Content type
application/json
{
  • "count": 1,
  • "jobs": [
    ]
}

Query jobs

Performs a job query.

Authorizations:
ApiKeyAuth
query Parameters
offset
integer <int32>

The number of results to skip, before returning any result. If offset is 0, no results are skipped.

limit
integer <int32>

Maximum number of results to return. If limit is 0, all results are returned.

Request Body schema: application/json
partition
string <date>

Partition filter.

id
integer <int32>

Job filter.

elementId
integer <int32>

Element filter.

elementInstanceId
integer <int32>

Element instance filter.

processId
integer <int32>

Process filter.

processInstanceId
integer <int32>

Process instance filter.

Responses

Request samples

Content type
application/json
{
  • "partition": "2025-04-11",
  • "processInstanceId": 576
}

Response samples

Content type
application/json
{
  • "count": 2,
  • "results": [
    ]
}

Unlock jobs

Unlocks locked, but uncompleted, jobs that are currently locked by a specific worker.

Authorizations:
ApiKeyAuth
Request Body schema: application/json
partition
string <date>

Partition condition.

id
integer <int32>

Job condition - must be used in combination with a partition.

workerId
required
string

Condition that restricts the jobs, to be locked by a specific worker.

Responses

Request samples

Content type
application/json
{
  • "partition": "2025-05-01",
  • "workerId": "default-worker"
}

Response samples

Content type
application/json
{
  • "count": 1
}

Complete job

Completes a locked job.

Authorizations:
ApiKeyAuth
path Parameters
partition
required
string <date>

Job partition.

id
required
integer <int32>

Job ID.

Request Body schema: application/json
object (JobCompletion)

A job completion is used to complete jobs of various types.

Array of objects (VariableData) <= 100 items

Variables to set or delete at element instance scope. For a variable deletion, no data must be provided.

error
string

Optional error, used to fail a job due to a technical problem.

Array of objects (VariableData) <= 100 items

Variables to set or delete at process instance scope. For a variable deletion, no data must be provided.

retryLimit
integer <int32> >= 0

Maximum number of retries. If the retry count is less than the retry limit, a retry job is created. Otherwise, an incident is created.

retryTimer
string

Duration until a retry job becomes due. At this point in time a retry job can be locked by a worker.

workerId
required
string

ID of the worker that locked and completed the job.

Responses

Request samples

Content type
application/json
Example
{
  • "processVariables": [
    ],
  • "workerId": "go-bpmn"
}

Response samples

Content type
application/json
{
  • "partition": "2025-05-01",
  • "id": 1042,
  • "elementId": 8,
  • "elementInstanceId": 2298,
  • "processId": 2,
  • "processInstanceId": 576,
  • "bpmnElementId": "serviceTaskA",
  • "completedAt": "2025-05-01T18:17:08.044Z",
  • "createdAt": "2025-05-01T17:44:19.997Z",
  • "createdBy": "go-bpmn",
  • "dueAt": "2025-05-01T17:44:19.997Z",
  • "lockedAt": "2025-05-01T17:59:30.657Z",
  • "lockedBy": "go-bpmn",
  • "retryCount": 0,
  • "state": "DONE",
  • "type": "EXECUTE"
}

Processes

A process represents a BPMN process that consists of a set of BPMN elements.

Create process

Creates a process that is modeled as BPMN XML.

If a process with the same BPMN process ID and version exists, the BPMN XML is compared. When the BPMN XML equals, the existing process is returned. When the BPMN XML differs, a problem of type CONFLICT is returned.

Authorizations:
ApiKeyAuth
Request Body schema: application/json
bpmnProcessId
required
string

ID of the process element within the BPMN XML.

bpmnXml
required
string

Model of the BPMN process as XML.

Array of objects (ErrorDefinition) <= 100 items

Error event definitions.

Array of objects (EscalationDefinition) <= 100 items

Escalation event definitions.

Array of objects (MessageDefinition) <= 100 items

Message event definitions.

parallelism
integer <int32> >= 0

Maximum number of parallel process instances being executed. If 0, the number of parallel process instances is unlimited.

Array of objects (SignalDefinition) <= 100 items

Signal event definitions.

Array of objects (Tag) <= 100 items

Tags.

Array of objects (TimerDefinition) <= 100 items

Timer event definitions.

version
required
string

Any process version.

workerId
required
string

ID of the worker that created the process.

Responses

Request samples

Content type
application/json
Example
{
  • "bpmnProcessId": "parallelServiceTasksTest",
  • "bpmnXml": "<...>",
  • "parallelism": 5,
  • "tags": [
    ],
  • "version": "1",
  • "workerId": "go-bpmn"
}

Response samples

Content type
application/json
{
  • "id": 2,
  • "bpmnProcessId": "parallelServiceTasksTest",
  • "createdAt": "2025-05-01T17:43:34.956Z",
  • "createdBy": "go-bpmn",
  • "parallelism": 5,
  • "tags": [
    ],
  • "version": "1"
}

Query processes

Performs a process query.

Authorizations:
ApiKeyAuth
query Parameters
offset
integer <int32>

The number of results to skip, before returning any result. If offset is 0, no results are skipped.

limit
integer <int32>

Maximum number of results to return. If limit is 0, all results are returned.

Request Body schema: application/json
id
integer <int32>

Process filter.

Array of objects (Tag) <= 100 items

Tags, a process must have, to be included.

Responses

Request samples

Content type
application/json
{
  • "id": 0,
  • "tags": [
    ]
}

Response samples

Content type
application/json
{
  • "count": 2,
  • "results": [
    ]
}

Get BPMN XML

Gets the BPMN XML of an existing process.

Authorizations:
ApiKeyAuth
path Parameters
id
required
integer <int32>

Process ID.

Responses

Response samples

Content type
application/problem+json
{
  • "status": 404,
  • "type": "NOT_FOUND",
  • "title": "failed to get BPMN XML",
  • "detail": "process 7 could not be found"
}

Process instances

A process instance is an instance of a BPMN process.

Create process instance

Creates a process instance from an existing process.

Authorizations:
ApiKeyAuth
Request Body schema: application/json
bpmnProcessId
required
string

BPMN ID of an existing process.

correlationKey
string

Optional key, used to correlate a process instance with a business entity.

Array of objects (Tag) <= 100 items

Tags.

Array of objects (VariableData) <= 100 items

Variables to set at process instance scope.

version
required
string

Version of an existing process.

workerId
required
string

ID of the worker that created the process instance.

Responses

Request samples

Content type
application/json
{
  • "bpmnProcessId": "parallelServiceTasksTest",
  • "correlationKey": "123456",
  • "tags": {
    },
  • "variables": [
    ],
  • "version": "1",
  • "workerId": "go-bpmn"
}

Response samples

Content type
application/json
{
  • "partition": "2025-04-11",
  • "id": 576,
  • "processId": 2,
  • "bpmnProcessId": "parallelServiceTasksTest",
  • "correlationKey": "123456",
  • "createdAt": "2025-05-01T17:44:19.997Z",
  • "createdBy": "go-bpmn",
  • "startedAt": "2025-05-01T17:44:19.997Z",
  • "state": "STARTED",
  • "tags": [
    ],
  • "version": "1"
}

Query process instances

Performs a process instance query.

Authorizations:
ApiKeyAuth
query Parameters
offset
integer <int32>

The number of results to skip, before returning any result. If offset is 0, no results are skipped.

limit
integer <int32>

Maximum number of results to return. If limit is 0, all results are returned.

Request Body schema: application/json
partition
string <date>

Partition filter.

id
integer <int32>

Process instance filter.

processId
integer <int32>

Process filter.

Array of objects (Tag) <= 100 items

Tags, a process instance must have, to be included.

Responses

Request samples

Content type
application/json
{
  • "partition": "2019-08-24",
  • "id": 0,
  • "processId": 0,
  • "tags": [
    ]
}

Response samples

Content type
application/json
{
  • "count": 2,
  • "results": [
    ]
}

Resume process instance

Resumes a suspended process instance.

Authorizations:
ApiKeyAuth
path Parameters
partition
required
string <date>

Process instance partition.

id
required
integer <int32>

Process instance ID.

Request Body schema: application/json
workerId
required
string

ID of the worker that resumed the process instance.

Responses

Request samples

Content type
application/json
{
  • "workerId": "go-bpmn"
}

Response samples

Content type
application/problem+json
{
  • "status": 404,
  • "type": "NOT_FOUND",
  • "title": "failed to resume process instance",
  • "detail": "process instance 2025-05-01/577 could not be found"
}

Suspend process instance

Suspends a started process instance.

Authorizations:
ApiKeyAuth
path Parameters
partition
required
string <date>

Process instance partition.

id
required
integer <int32>

Process instance ID.

Request Body schema: application/json
workerId
required
string

ID of the worker that suspended the process instance.

Responses

Request samples

Content type
application/json
{
  • "workerId": "go-bpmn"
}

Response samples

Content type
application/problem+json
{
  • "status": 404,
  • "type": "NOT_FOUND",
  • "title": "failed to suspend process instance",
  • "detail": "process instance 2025-05-01/577 could not be found"
}

Get process variables

Gets variables of an active or ended process instance.

Authorizations:
ApiKeyAuth
path Parameters
partition
required
string <date>

Process instance partition.

id
required
integer <int32>

Process instance ID.

query Parameters
names
string
Examples: names=a,b,c

Comma separated list of variables to include.

Responses

Response samples

Content type
application/json
{
  • "count": 2,
  • "variables": [
    ]
}

Set process variables

Sets or deletes variables of an active process instance.

Authorizations:
ApiKeyAuth
path Parameters
partition
required
string <date>

Process instance partition.

id
required
integer <int32>

Process instance ID.

Request Body schema: application/json
Array of objects (VariableData) <= 100 items

Variables to set or delete. For a variable deletion, no data must be provided.

workerId
required
string

ID of the worker that set the variables.

Responses

Request samples

Content type
application/json
Example
{
  • "variables": {
    },
  • "workerId": "go-bpmn"
}

Response samples

Content type
application/problem+json
{
  • "status": 400,
  • "type": "HTTP_REQUEST_BODY",
  • "title": "invalid request body",
  • "detail": "failed to validate request body",
  • "errors": [
    ]
}

Tasks

A task is a unit of work, which must be locked, executed and completed by an engine.

Execute tasks

Locks and executes due tasks, which match the specified conditions.

Due tasks are normally handled by a task executor, running inside the engine. When waiting for a due task to be completed during testing, this operation must be called!

Authorizations:
ApiKeyAuth
Request Body schema: application/json
partition
string <date>

Partition condition.

id
integer <int32>

Task condition - must be used in combination with a partition.

processId
integer <int32>

Process condition.

processInstanceId
integer <int32>

Process instance condition - must be used in combination with a partition.

type
string (TaskType)
Enum: "DEQUEUE_PROCESS_INSTANCE" "JOIN_PARALLEL_GATEWAY" "START_PROCESS_INSTANCE" "TRIGGER_EVENT" "CREATE_PARTITION" "DETACH_PARTITION" "DROP_PARTITION" "PURGE_MESSAGES" "PURGE_SIGNALS"

TaskType describes the different types of tasks, an engine needs to execute.

  • DEQUEUE_PROCESS_INSTANCE dequeues a queued process instance
  • JOIN_PARALLEL_GATEWAY continues a parallel gateway by joining executions
  • START_PROCESS_INSTANCE starts a queued process instance
  • TRIGGER_EVENT triggers a message, signal or timer event

Management related types, that are only relevant for a pg engine:

  • CREATE_PARTITION creates a table partition for a specific date
  • DETACH_PARTITION detaches a completed table partition
  • DROP_PARTITION drops a detached table partition
  • PURGE_MESSAGES purges messages that are expired
  • PURGE_SIGNALS purges signals that have no active subscribers anymore
limit
integer <int32> [ 1 .. 100 ]

Maximum number of tasks to lock and execute.

Responses

Request samples

Content type
application/json
{
  • "partition": "2025-05-01",
  • "processInstanceId": 576,
  • "limit": 1
}

Response samples

Content type
application/json
{
  • "locked": 1,
  • "completed": 1,
  • "failed": 0,
  • "completedTasks": [
    ],
  • "failedTasks": [ ]
}

Query tasks

Performs a task query.

Authorizations:
ApiKeyAuth
query Parameters
offset
integer <int32>

The number of results to skip, before returning any result. If offset is 0, no results are skipped.

limit
integer <int32>

Maximum number of results to return. If limit is 0, all results are returned.

Request Body schema: application/json
partition
string <date>

Partition filter.

id
integer <int32>

Task filter.

elementId
integer <int32>

Element filter.

elementInstanceId
integer <int32>

Element instance filter.

processId
integer <int32>

Process filter.

processInstanceId
integer <int32>

Process instance filter.

type
string (TaskType)
Enum: "DEQUEUE_PROCESS_INSTANCE" "JOIN_PARALLEL_GATEWAY" "START_PROCESS_INSTANCE" "TRIGGER_EVENT" "CREATE_PARTITION" "DETACH_PARTITION" "DROP_PARTITION" "PURGE_MESSAGES" "PURGE_SIGNALS"

TaskType describes the different types of tasks, an engine needs to execute.

  • DEQUEUE_PROCESS_INSTANCE dequeues a queued process instance
  • JOIN_PARALLEL_GATEWAY continues a parallel gateway by joining executions
  • START_PROCESS_INSTANCE starts a queued process instance
  • TRIGGER_EVENT triggers a message, signal or timer event

Management related types, that are only relevant for a pg engine:

  • CREATE_PARTITION creates a table partition for a specific date
  • DETACH_PARTITION detaches a completed table partition
  • DROP_PARTITION drops a detached table partition
  • PURGE_MESSAGES purges messages that are expired
  • PURGE_SIGNALS purges signals that have no active subscribers anymore

Responses

Request samples

Content type
application/json
{
  • "partition": "2019-08-24",
  • "id": 0,
  • "elementId": 0,
  • "elementInstanceId": 0,
  • "processId": 0,
  • "processInstanceId": 0,
  • "type": "DEQUEUE_PROCESS_INSTANCE"
}

Response samples

Content type
application/json
{
  • "count": 3,
  • "results": [
    ]
}

Unlock tasks

Unlocks locked, but uncompleted, tasks that are currently locked by a specific engine.

Authorizations:
ApiKeyAuth
Request Body schema: application/json
partition
string <date>

Partition condition.

id
integer <int32>

Task condition - must be used in combination with a partition.

engineId
required
string

Condition that restricts the tasks, to be locked by a specific engine.

Responses

Request samples

Content type
application/json
{
  • "partition": "2025-05-01",
  • "engineId": "default-engine"
}

Response samples

Content type
application/json
{
  • "count": 1
}

Variables

A variable is data, identified by a name, that exists in the scope of a process instance or element instance.

Get element variables

Gets variables of an active or ended element instance.

Authorizations:
ApiKeyAuth
path Parameters
partition
required
string <date>

Element instance partition.

id
required
integer <int32>

Element instance ID.

query Parameters
names
string
Examples: names=a,b,c

Comma separated list of variables to include.

Responses

Response samples

Content type
application/json
{
  • "count": 2,
  • "variables": [
    ]
}

Set element variables

Sets or deletes variables of an active element instance.

Authorizations:
ApiKeyAuth
path Parameters
partition
required
string <date>

Element instance partition.

id
required
integer <int32>

Element instance ID.

Request Body schema: application/json
Array of objects (VariableData) <= 100 items

Variables to set or delete. For a variable deletion, no data must be provided.

workerId
required
string

ID of the worker that set the variables.

Responses

Request samples

Content type
application/json
Example
{
  • "variables": {
    },
  • "workerId": "go-bpmn"
}

Response samples

Content type
application/problem+json
{
  • "status": 400,
  • "type": "HTTP_REQUEST_BODY",
  • "title": "invalid request body",
  • "detail": "failed to validate request body",
  • "errors": [
    ]
}

Get process variables

Gets variables of an active or ended process instance.

Authorizations:
ApiKeyAuth
path Parameters
partition
required
string <date>

Process instance partition.

id
required
integer <int32>

Process instance ID.

query Parameters
names
string
Examples: names=a,b,c

Comma separated list of variables to include.

Responses

Response samples

Content type
application/json
{
  • "count": 2,
  • "variables": [
    ]
}

Set process variables

Sets or deletes variables of an active process instance.

Authorizations:
ApiKeyAuth
path Parameters
partition
required
string <date>

Process instance partition.

id
required
integer <int32>

Process instance ID.

Request Body schema: application/json
Array of objects (VariableData) <= 100 items

Variables to set or delete. For a variable deletion, no data must be provided.

workerId
required
string

ID of the worker that set the variables.

Responses

Request samples

Content type
application/json
Example
{
  • "variables": {
    },
  • "workerId": "go-bpmn"
}

Response samples

Content type
application/problem+json
{
  • "status": 400,
  • "type": "HTTP_REQUEST_BODY",
  • "title": "invalid request body",
  • "detail": "failed to validate request body",
  • "errors": [
    ]
}

Query variables

Performs a variable query.

Authorizations:
ApiKeyAuth
query Parameters
offset
integer <int32>

The number of results to skip, before returning any result. If offset is 0, no results are skipped.

limit
integer <int32>

Maximum number of results to return. If limit is 0, all results are returned.

Request Body schema: application/json
partition
string <date>

Partition filter.

elementInstanceId
integer <int32>

Element instance filter.

processInstanceId
integer <int32>

Process instance filter.

names
Array of strings

Names of variables to include.

Responses

Request samples

Content type
application/json
{
  • "partition": "2025-05-09",
  • "processInstanceId": 48,
  • "names": [
    ]
}

Response samples

Content type
application/json
{
  • "count": 1,
  • "results": [
    ]
}

Check readiness

Determines if the server is ready to accept requests.

Responses

Response samples

Content type
text/plain
ready

Set time

Increases the engine's time for testing purposes.

Authorizations:
ApiKeyAuth
Request Body schema: application/json
time
required
string <date-time>

A future point in time.

Responses

Request samples

Content type
application/json
{
  • "time": "2025-05-10T00:00:00.000Z"
}

Response samples

Content type
application/problem+json
{
  • "status": 409,
  • "type": "CONFLICT",
  • "title": "failed to set time",
  • "detail": "time 2025-05-08T17:43:56Z is before engine time 2025-05-09T19:19:21Z"
}