Evaluate Get Started Plugins Glossary

Workflow Engine HTTP API

OptimaJet Team OptimaJet Team Updated 1 min read 73 words
development web-api openapi Additional
API docs by Redocly

Workflow Engine HTTP API (1.0)

Download OpenAPI specification:OpenAPI YAMLOpenAPI JSON

The Workflow Engine HTTP API exposes endpoints for applications that host a Workflow Runtime and manage each Process Instance. Use this generated reference to inspect request parameters, response schemas, and authentication requirements, then download an OpenAPI document for client generation or local tooling.

Root

Check service is running

Authorizations:
Bearer

Responses

Response samples

Content type
application/json
{
  • "code": "Unknown",
  • "message": "string",
  • "errors": {
    }
}

Check all tenants is ready to accept requests

Authorizations:
Bearer

Responses

Response samples

Content type
application/json
{
  • "isHealthy": true,
  • "message": "string",
  • "tenantStatuses": [
    ]
}

Check specific tenant is ready to accept requests

Authorizations:
Bearer

Responses

Response samples

Content type
application/json
{
  • "tenantStatus": {
    }
}

Runtimes

Retrieve runtimes collection and total count, with optional search, filters, sorting, and paging.

Authorizations:
Bearer
Request Body schema: application/json
required
search
string or null
Array of objects or null (RuntimeFieldFilter)
Array of objects or null (RuntimeFieldSort)
skip
integer <int64>
take
integer <int64>

Responses

Request samples

Content type
application/json
{
  • "search": "string",
  • "filters": [
    ],
  • "sorts": [
    ],
  • "skip": 0,
  • "take": 0
}

Response samples

Content type
application/json
{
  • "collection": [
    ],
  • "total": 0
}

Retrieve runtimes collection and total count, with optional search, filters, sorting, and paging.

Authorizations:
Bearer
query Parameters
search
string
Array of objects (RuntimeFieldFilter)
Array of objects (RuntimeFieldSort)
skip
integer <int64>
Default: 0
take
integer <int64>
Default: 0

Responses

Response samples

Content type
application/json
{
  • "collection": [
    ],
  • "total": 0
}

Retrieve a single runtime by ID.

Authorizations:
Bearer
path Parameters
id
required
string

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "lock": "3cb27986-df09-4549-a834-b2869eecacb5",
  • "status": "Alive",
  • "restorerId": "string",
  • "nextTimerTime": "2019-08-24T14:15:22Z",
  • "nextServiceTimerTime": "2019-08-24T14:15:22Z",
  • "lastAliveSignal": "2019-08-24T14:15:22Z"
}

GlobalParameters

Retrieve global parameters collection and total count, with optional search, filters, sorting, and paging.

Authorizations:
Bearer
Request Body schema: application/json
required
search
string or null
Array of objects or null (GlobalParameterFieldFilter)
Array of objects or null (GlobalParameterFieldSort)
skip
integer <int64>
take
integer <int64>

Responses

Request samples

Content type
application/json
{
  • "search": "string",
  • "filters": [
    ],
  • "sorts": [
    ],
  • "skip": 0,
  • "take": 0
}

Response samples

Content type
application/json
{
  • "collection": [
    ],
  • "total": 0
}

Retrieve global parameters collection and total count, with optional search, filters, sorting, and paging.

Authorizations:
Bearer
query Parameters
search
string
Array of objects (GlobalParameterFieldFilter)
Array of objects (GlobalParameterFieldSort)
skip
integer <int64>
Default: 0
take
integer <int64>
Default: 0

Responses

Response samples

Content type
application/json
{
  • "collection": [
    ],
  • "total": 0
}

Create multiple global parameters from an array of creation requests.

Authorizations:
Bearer
Request Body schema: application/json
required
Array
type
string or null
name
string or null
value
any or null

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "createdCount": 0
}

Delete multiple global parameters based on optional filters.

Authorizations:
Bearer
query Parameters
Array of objects (GlobalParameterFieldFilter)

Responses

Response samples

Content type
application/json
{
  • "deletedCount": 0
}

Retrieve a single global parameter by type and name.

Authorizations:
Bearer
path Parameters
type
required
string
name
required
string

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "type": "string",
  • "name": "string",
  • "value": null,
  • "tenantId": "string"
}

Create a single global parameter using type, name and creation request.

Authorizations:
Bearer
path Parameters
type
required
string
name
required
string
Request Body schema: application/json
required
value
any or null

Responses

Request samples

Content type
application/json
{
  • "value": null
}

Response samples

Content type
application/json
{ }

Update a single global parameter by type and name, using an update request.

Authorizations:
Bearer
path Parameters
type
required
string
name
required
string
Request Body schema: application/json
required
type
string or null
name
string or null
value
any or null

Responses

Request samples

Content type
application/json
{
  • "type": "string",
  • "name": "string",
  • "value": null
}

Response samples

Content type
application/json
{
  • "updatedCount": 0
}

Delete a single global parameter by type and name.

Authorizations:
Bearer
path Parameters
type
required
string
name
required
string

Responses

Response samples

Content type
application/json
{
  • "deletedCount": 0
}

Schemes

Retrieve schemes collection and total count, with optional search, filters, sorting, and paging.

Authorizations:
Bearer
Request Body schema: application/json
required
search
string or null
Array of objects or null (SchemeFieldFilter)
Array of objects or null (SchemeFieldSort)
skip
integer <int64>
take
integer <int64>

Responses

Request samples

Content type
application/json
{
  • "search": "string",
  • "filters": [
    ],
  • "sorts": [
    ],
  • "skip": 0,
  • "take": 0
}

Response samples

Content type
application/json
{
  • "collection": [
    ],
  • "total": 0
}

Retrieve schemes collection and total count, with optional search, filters, sorting, and paging.

Authorizations:
Bearer
query Parameters
search
string
Array of objects (SchemeFieldFilter)
Array of objects (SchemeFieldSort)
skip
integer <int64>
Default: 0
take
integer <int64>
Default: 0

Responses

Response samples

Content type
application/json
{
  • "collection": [
    ],
  • "total": 0
}

Create multiple schemes from an array of creation requests.

Authorizations:
Bearer
Request Body schema: application/json
required
Array
code
string or null
object (Scheme)
canBeInlined
boolean
inlinedSchemes
Array of strings or null
tags
Array of strings or null

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "createdCount": 0
}

Delete multiple schemes based on optional filters.

Authorizations:
Bearer
query Parameters
Array of objects (SchemeFieldFilter)

Responses

Response samples

Content type
application/json
{
  • "deletedCount": 0
}

Retrieve a single scheme by code.

Authorizations:
Bearer
path Parameters
code
required
string

Responses

Response samples

Content type
application/json
{
  • "code": "string",
  • "scheme": {
    },
  • "canBeInlined": true,
  • "inlinedSchemes": [
    ],
  • "tags": [
    ],
  • "tenantId": "string"
}

Create a single scheme using code and creation request.

Authorizations:
Bearer
path Parameters
code
required
string
Request Body schema: application/json
required
object (Scheme)
canBeInlined
boolean
inlinedSchemes
Array of strings or null
tags
Array of strings or null

Responses

Request samples

Content type
application/json
{
  • "scheme": {
    },
  • "canBeInlined": true,
  • "inlinedSchemes": [
    ],
  • "tags": [
    ]
}

Response samples

Content type
application/json
{ }

Update a single scheme by code, using an update request.

Authorizations:
Bearer
path Parameters
code
required
string
Request Body schema: application/json
required
code
string or null
object (Scheme)
canBeInlined
boolean or null
inlinedSchemes
Array of strings or null
tags
Array of strings or null

Responses

Request samples

Content type
application/json
{
  • "code": "string",
  • "scheme": {
    },
  • "canBeInlined": true,
  • "inlinedSchemes": [
    ],
  • "tags": [
    ]
}

Response samples

Content type
application/json
{
  • "updatedCount": 0
}

Delete a single scheme by code.

Authorizations:
Bearer
path Parameters
code
required
string

Responses

Response samples

Content type
application/json
{
  • "deletedCount": 0
}

Statuses

Retrieve process statuses collection and total count, with optional search, filters, sorting, and paging.

Authorizations:
Bearer
Request Body schema: application/json
required
search
string or null
Array of objects or null (StatusFieldFilter)
Array of objects or null (StatusFieldSort)
skip
integer <int64>
take
integer <int64>

Responses

Request samples

Content type
application/json
{
  • "search": "string",
  • "filters": [
    ],
  • "sorts": [
    ],
  • "skip": 0,
  • "take": 0
}

Response samples

Content type
application/json
{
  • "collection": [
    ],
  • "total": 0
}

Retrieve process statuses collection and total count, with optional search, filters, sorting, and paging.

Authorizations:
Bearer
query Parameters
search
string
Array of objects (StatusFieldFilter)
Array of objects (StatusFieldSort)
skip
integer <int64>
Default: 0
take
integer <int64>
Default: 0

Responses

Response samples

Content type
application/json
{
  • "collection": [
    ],
  • "total": 0
}

Retrieve a single process status by process ID.

Authorizations:
Bearer
path Parameters
processId
required
string <uuid>

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "statusCode": 0,
  • "lock": "3cb27986-df09-4549-a834-b2869eecacb5",
  • "runtimeId": "string",
  • "setTime": "2019-08-24T14:15:22Z"
}

Processes

Retrieve processes collection and total count, with optional search, filters, sorting, and paging.

Authorizations:
Bearer
Request Body schema: application/json
required
search
string or null
Array of objects or null (ProcessFieldFilter)
Array of objects or null (ProcessFieldSort)
skip
integer <int64>
take
integer <int64>

Responses

Request samples

Content type
application/json
{
  • "search": "string",
  • "filters": [
    ],
  • "sorts": [
    ],
  • "skip": 0,
  • "take": 0
}

Response samples

Content type
application/json
{
  • "collection": [
    ],
  • "total": 0
}

Retrieve processes collection and total count, with optional search, filters, sorting, and paging.

Authorizations:
Bearer
query Parameters
search
string
Array of objects (ProcessFieldFilter)
Array of objects (ProcessFieldSort)
skip
integer <int64>
Default: 0
take
integer <int64>
Default: 0

Responses

Response samples

Content type
application/json
{
  • "collection": [
    ],
  • "total": 0
}

Retrieve a single process by ID.

Authorizations:
Bearer
path Parameters
id
required
string <uuid>

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "stateName": "string",
  • "activityName": "string",
  • "schemeId": "d50fd494-6cfc-4f45-83a9-47603a003465",
  • "previousState": "string",
  • "previousStateForDirect": "string",
  • "previousStateForReverse": "string",
  • "previousActivity": "string",
  • "previousActivityForDirect": "string",
  • "previousActivityForReverse": "string",
  • "parentProcessId": "0b8e9096-348a-4528-9c4f-06a402b244ad",
  • "rootProcessId": "40cf4e06-2f74-499b-989d-4bc9ab21fd8b",
  • "tenantId": "string",
  • "startingTransition": "string",
  • "subprocessName": "string",
  • "creationDate": "2019-08-24T14:15:22Z",
  • "lastTransitionDate": "2019-08-24T14:15:22Z",
  • "calendarName": "string"
}

Update a single process by ID.

Authorizations:
Bearer
path Parameters
id
required
string <uuid>
Request Body schema: application/json
required
calendarName
string or null

Responses

Request samples

Content type
application/json
{
  • "calendarName": "string"
}

Response samples

Content type
application/json
{
  • "updatedCount": 0
}

Parameters

Retrieve parameters collection and total count across all process instances, with optional search, filters, sorting, and paging.

Authorizations:
Bearer
Request Body schema: application/json
required
search
string or null
Array of objects or null (ParameterFieldFilter)
Array of objects or null (ParameterFieldSort)
skip
integer <int64>
take
integer <int64>

Responses

Request samples

Content type
application/json
{
  • "search": "string",
  • "filters": [
    ],
  • "sorts": [
    ],
  • "skip": 0,
  • "take": 0
}

Response samples

Content type
application/json
{
  • "collection": [
    ],
  • "total": 0
}

Retrieve parameters collection and total count for a specific process instance ID, with optional search, filters, sorting, and paging.

Authorizations:
Bearer
path Parameters
processId
required
string <uuid>
query Parameters
search
string
Array of objects (ParameterFieldFilter)
Array of objects (ParameterFieldSort)
skip
integer <int64>
Default: 0
take
integer <int64>
Default: 0

Responses

Response samples

Content type
application/json
{
  • "collection": [
    ],
  • "total": 0
}

Create multiple parameters for a specific process instance ID from an array of creation requests.

Authorizations:
Bearer
path Parameters
processId
required
string <uuid>
Request Body schema: application/json
required
Array
name
string or null
value
any or null

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "createdCount": 0
}

Delete multiple parameters for a specific process instance ID, with optional filters.

Authorizations:
Bearer
path Parameters
processId
required
string <uuid>
query Parameters
Array of objects (ParameterFieldFilter)

Responses

Response samples

Content type
application/json
{
  • "deletedCount": 0
}

Retrieve a single parameter for a specific process instance ID and parameter name.

Authorizations:
Bearer
path Parameters
processId
required
string <uuid>
name
required
string

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "processId": "9e0ad09b-5150-48c0-aded-707587048fd9",
  • "name": "string",
  • "value": null
}

Create a single parameter for a specific process instance ID using parameter name and creation request.

Authorizations:
Bearer
path Parameters
processId
required
string <uuid>
name
required
string
Request Body schema: application/json
required
value
any or null

Responses

Request samples

Content type
application/json
{
  • "value": null
}

Response samples

Content type
application/json
{ }

Update a single parameter for a specific process instance ID and parameter name, using an update request.

Authorizations:
Bearer
path Parameters
processId
required
string <uuid>
name
required
string
Request Body schema: application/json
required
name
string or null
value
any or null

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "value": null
}

Response samples

Content type
application/json
{
  • "updatedCount": 0
}

Delete a single parameter for a specific process instance ID and parameter name.

Authorizations:
Bearer
path Parameters
processId
required
string <uuid>
name
required
string

Responses

Response samples

Content type
application/json
{
  • "deletedCount": 0
}

Timers

Retrieve timers collection and total count across all process instances, with optional search, filters, sorting, and paging.

Authorizations:
Bearer
Request Body schema: application/json
required
search
string or null
Array of objects or null (TimerFieldFilter)
Array of objects or null (TimerFieldSort)
skip
integer <int64>
take
integer <int64>

Responses

Request samples

Content type
application/json
{
  • "search": "string",
  • "filters": [
    ],
  • "sorts": [
    ],
  • "skip": 0,
  • "take": 0
}

Response samples

Content type
application/json
{
  • "collection": [
    ],
  • "total": 0
}

Retrieve timers collection and total count for a specific process instance ID, with optional search, filters, sorting, and paging.

Authorizations:
Bearer
path Parameters
processId
required
string <uuid>
query Parameters
search
string
Array of objects (TimerFieldFilter)
Array of objects (TimerFieldSort)
skip
integer <int64>
Default: 0
take
integer <int64>
Default: 0

Responses

Response samples

Content type
application/json
{
  • "collection": [
    ],
  • "total": 0
}

Create multiple timers for a specific process instance ID from an array of creation requests.

Authorizations:
Bearer
path Parameters
processId
required
string <uuid>
Request Body schema: application/json
required
Array
name
string or null
rootProcessId
string <uuid>
nextExecutionDateTime
string <date-time>
ignore
boolean

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "createdCount": 0
}

Delete multiple timers for a specific process instance ID, with optional filters.

Authorizations:
Bearer
path Parameters
processId
required
string <uuid>
query Parameters
Array of objects (TimerFieldFilter)

Responses

Response samples

Content type
application/json
{
  • "deletedCount": 0
}

Retrieve a single timer for a specific process instance ID and timer name.

Authorizations:
Bearer
path Parameters
processId
required
string <uuid>
name
required
string

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "processId": "9e0ad09b-5150-48c0-aded-707587048fd9",
  • "rootProcessId": "40cf4e06-2f74-499b-989d-4bc9ab21fd8b",
  • "name": "string",
  • "nextExecutionDateTime": "2019-08-24T14:15:22Z",
  • "ignore": true
}

Create a single timer for a specific process instance ID, using timer name and creation request.

Authorizations:
Bearer
path Parameters
processId
required
string <uuid>
name
required
string
Request Body schema: application/json
required
rootProcessId
string <uuid>
nextExecutionDateTime
string <date-time>
ignore
boolean

Responses

Request samples

Content type
application/json
{
  • "rootProcessId": "40cf4e06-2f74-499b-989d-4bc9ab21fd8b",
  • "nextExecutionDateTime": "2019-08-24T14:15:22Z",
  • "ignore": true
}

Response samples

Content type
application/json
{ }

Update a single timer for a specific process instance ID and timer name, using an update request.

Authorizations:
Bearer
path Parameters
processId
required
string <uuid>
name
required
string
Request Body schema: application/json
required
name
string or null
nextExecutionDateTime
string or null <date-time>
ignore
boolean or null

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "nextExecutionDateTime": "2019-08-24T14:15:22Z",
  • "ignore": true
}

Response samples

Content type
application/json
{
  • "updatedCount": 0
}

Delete a single timer for a specific process instance ID and timer name.

Authorizations:
Bearer
path Parameters
processId
required
string <uuid>
name
required
string

Responses

Response samples

Content type
application/json
{
  • "deletedCount": 0
}

Transitions

Retrieve transitions collection and total count across all process instances, with optional search, filters, sorting, and paging.

Authorizations:
Bearer
Request Body schema: application/json
required
search
string or null
Array of objects or null (TransitionFieldFilter)
Array of objects or null (TransitionFieldSort)
skip
integer <int64>
take
integer <int64>

Responses

Request samples

Content type
application/json
{
  • "search": "string",
  • "filters": [
    ],
  • "sorts": [
    ],
  • "skip": 0,
  • "take": 0
}

Response samples

Content type
application/json
{
  • "collection": [
    ],
  • "total": 0
}

Retrieve transitions collection and total count for a specific process instance ID, with optional search, filters, sorting, and paging.

Authorizations:
Bearer
path Parameters
processId
required
string <uuid>
query Parameters
search
string
Array of objects (TransitionFieldFilter)
Array of objects (TransitionFieldSort)
skip
integer <int64>
Default: 0
take
integer <int64>
Default: 0

Responses

Response samples

Content type
application/json
{
  • "collection": [
    ],
  • "total": 0
}

Delete multiple transitions for a specific process instance ID, with optional filters.

Authorizations:
Bearer
path Parameters
processId
required
string <uuid>
query Parameters
Array of objects (TransitionFieldFilter)

Responses

Response samples

Content type
application/json
{
  • "deletedCount": 0
}

Retrieve a single transition for a specific process instance ID and transition ID.

Authorizations:
Bearer
path Parameters
processId
required
string <uuid>
id
required
string <uuid>

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "processId": "9e0ad09b-5150-48c0-aded-707587048fd9",
  • "executorIdentityId": "string",
  • "actorIdentityId": "string",
  • "executorName": "string",
  • "actorName": "string",
  • "fromActivityName": "string",
  • "toActivityName": "string",
  • "toStateName": "string",
  • "transitionTime": "2019-08-24T14:15:22Z",
  • "transitionClassifier": "string",
  • "isFinalised": true,
  • "fromStateName": "string",
  • "triggerName": "string",
  • "startTransitionTime": "2019-08-24T14:15:22Z",
  • "transitionDuration": 0
}

Delete a single transition for a specific process instance ID and transition ID.

Authorizations:
Bearer
path Parameters
processId
required
string <uuid>
id
required
string <uuid>

Responses

Response samples

Content type
application/json
{
  • "deletedCount": 0
}

Approvals

Retrieve approval history entries collection and total count across all process instances, with optional search, filters, sorting, and paging.

Authorizations:
Bearer
Request Body schema: application/json
required
search
string or null
Array of objects or null (ApprovalFieldFilter)
Array of objects or null (ApprovalFieldSort)
skip
integer <int64>
take
integer <int64>

Responses

Request samples

Content type
application/json
{
  • "search": "string",
  • "filters": [
    ],
  • "sorts": [
    ],
  • "skip": 0,
  • "take": 0
}

Response samples

Content type
application/json
{
  • "collection": [
    ],
  • "total": 0
}

Retrieve approval history entries collection and total count for a specific process instance ID, with optional search, filters, sorting, and paging.

Authorizations:
Bearer
path Parameters
processId
required
string <uuid>
query Parameters
search
string
Array of objects (ApprovalFieldFilter)
Array of objects (ApprovalFieldSort)
skip
integer <int64>
Default: 0
take
integer <int64>
Default: 0

Responses

Response samples

Content type
application/json
{
  • "collection": [
    ],
  • "total": 0
}

Delete multiple approval history entries for a specific process instance ID, with optional filters.

Authorizations:
Bearer
path Parameters
processId
required
string <uuid>
query Parameters
Array of objects (ApprovalFieldFilter)

Responses

Response samples

Content type
application/json
{
  • "deletedCount": 0
}

Retrieve a single approval history entry for a specific process instance ID and entry ID.

Authorizations:
Bearer
path Parameters
processId
required
string <uuid>
id
required
string <uuid>

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "processId": "9e0ad09b-5150-48c0-aded-707587048fd9",
  • "identityId": "string",
  • "allowedTo": [
    ],
  • "transitionTime": "2019-08-24T14:15:22Z",
  • "sort": 0,
  • "initialState": "string",
  • "destinationState": "string",
  • "triggerName": "string",
  • "commentary": "string"
}

Delete a single approval history entry for a specific process instance ID and entry ID.

Authorizations:
Bearer
path Parameters
processId
required
string <uuid>
id
required
string <uuid>

Responses

Response samples

Content type
application/json
{
  • "deletedCount": 0
}

InboxEntries

Retrieve inbox entries collection and total count across all process instances, with optional search, filters, sorting, and paging.

Authorizations:
Bearer
Request Body schema: application/json
required
search
string or null
Array of objects or null (InboxEntryFieldFilter)
Array of objects or null (InboxEntryFieldSort)
skip
integer <int64>
take
integer <int64>

Responses

Request samples

Content type
application/json
{
  • "search": "string",
  • "filters": [
    ],
  • "sorts": [
    ],
  • "skip": 0,
  • "take": 0
}

Response samples

Content type
application/json
{
  • "collection": [
    ],
  • "total": 0
}

Retrieve inbox entries collection and total count for a specific process instance ID, with optional search, filters, sorting, and paging.

Authorizations:
Bearer
path Parameters
processId
required
string <uuid>
query Parameters
search
string
Array of objects (InboxEntryFieldFilter)
Array of objects (InboxEntryFieldSort)
skip
integer <int64>
Default: 0
take
integer <int64>
Default: 0

Responses

Response samples

Content type
application/json
{
  • "collection": [
    ],
  • "total": 0
}

Delete multiple inbox entries for a specific process instance ID, with optional filters.

Authorizations:
Bearer
path Parameters
processId
required
string <uuid>
query Parameters
Array of objects (InboxEntryFieldFilter)

Responses

Response samples

Content type
application/json
{
  • "deletedCount": 0
}

Retrieve a single inbox entry for a specific process instance ID and identity ID.

Authorizations:
Bearer
path Parameters
processId
required
string <uuid>
identityId
required
string

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "processId": "9e0ad09b-5150-48c0-aded-707587048fd9",
  • "identityId": "string",
  • "addingDate": "2019-08-24T14:15:22Z",
  • "availableCommands": [
    ]
}

Delete a single inbox entry for a specific process instance ID and identity ID.

Authorizations:
Bearer
path Parameters
processId
required
string <uuid>
identityId
required
string

Responses

Response samples

Content type
application/json
{
  • "deletedCount": 0
}

RpcBulk

Create multiple process instances.

Authorizations:
Bearer
Request Body schema: application/json
required
Array of objects or null (CreateInstanceParamsItem)
maxDegreeOfParallelism
integer or null <int32>

Responses

Request samples

Content type
application/json
{
  • "createInstanceParamsList": [
    ],
  • "maxDegreeOfParallelism": 0
}

Response samples

Content type
application/json
{
  • "property1": {
    },
  • "property2": {
    }
}

Get multiple process instances with parameters.

Authorizations:
Bearer
Request Body schema: application/json
required
processIds
Array of strings or null <uuid> [ items <uuid > ]
maxDegreeOfParallelism
integer or null <int32>

Responses

Request samples

Content type
application/json
{
  • "processIds": [
    ],
  • "maxDegreeOfParallelism": 0
}

Response samples

Content type
application/json
{
  • "property1": {
    },
  • "property2": {
    }
}

Get multiple root process instances with all subprocesses as trees.

Authorizations:
Bearer
Request Body schema: application/json
required
rootProcessIds
Array of strings or null <uuid> [ items <uuid > ]
maxDegreeOfParallelism
integer or null <int32>

Responses

Request samples

Content type
application/json
{
  • "rootProcessIds": [
    ],
  • "maxDegreeOfParallelism": 0
}

Response samples

Content type
application/json
{
  • "property1": {
    },
  • "property2": {
    }
}

Get multiple lists of commands available for current activities and identities.

Authorizations:
Bearer
Request Body schema: application/json
required
processIds
Array of strings or null <uuid> [ items <uuid > ]
identityIds
Array of strings or null
commandNameFilter
string or null
culture
string or null
conditionCheck
boolean
maxDegreeOfParallelism
integer or null <int32>

Responses

Request samples

Content type
application/json
{
  • "processIds": [
    ],
  • "identityIds": [
    ],
  • "commandNameFilter": "string",
  • "culture": "string",
  • "conditionCheck": true,
  • "maxDegreeOfParallelism": 0
}

Response samples

Content type
application/json
{
  • "property1": {
    },
  • "property2": {
    }
}

Execute multiple commands with specified identity.

Authorizations:
Bearer
Request Body schema: application/json
required
Array of objects or null (WorkflowCommand)
identityId
string or null
impersonatedIdentityId
string or null
checkRestrictions
boolean
maxDegreeOfParallelism
integer or null <int32>

Responses

Request samples

Content type
application/json
{
  • "commands": [
    ],
  • "identityId": "string",
  • "impersonatedIdentityId": "string",
  • "checkRestrictions": true,
  • "maxDegreeOfParallelism": 0
}

Response samples

Content type
application/json
{
  • "property1": {
    },
  • "property2": {
    }
}

Update multiple schemes of process instances if they are obsolete.

Authorizations:
Bearer
Request Body schema: application/json
required
processIds
Array of strings or null <uuid> [ items <uuid > ]
ignoreAutoSchemeUpdate
boolean
maxDegreeOfParallelism
integer or null <int32>

Responses

Request samples

Content type
application/json
{
  • "processIds": [
    ],
  • "ignoreAutoSchemeUpdate": true,
  • "maxDegreeOfParallelism": 0
}

Response samples

Content type
application/json
{
  • "property1": {
    },
  • "property2": {
    }
}

Delete multiple process instances with all their subprocesses.

Authorizations:
Bearer
Request Body schema: application/json
required
processIds
Array of strings or null <uuid> [ items <uuid > ]
maxDegreeOfParallelism
integer or null <int32>

Responses

Request samples

Content type
application/json
{
  • "processIds": [
    ],
  • "maxDegreeOfParallelism": 0
}

Response samples

Content type
application/json
{
  • "property1": {
    },
  • "property2": {
    }
}

Check existence of multiple process instances.

Authorizations:
Bearer
Request Body schema: application/json
required
processIds
Array of strings or null <uuid> [ items <uuid > ]
maxDegreeOfParallelism
integer or null <int32>

Responses

Request samples

Content type
application/json
{
  • "processIds": [
    ],
  • "maxDegreeOfParallelism": 0
}

Response samples

Content type
application/json
{
  • "property1": {
    },
  • "property2": {
    }
}

RpcCommands

Get the list of commands available for current activity and identities.

Authorizations:
Bearer
Request Body schema: application/json
required
processId
string <uuid>
identityIds
Array of strings or null
commandNameFilter
string or null
culture
string or null
conditionCheck
boolean

Responses

Request samples

Content type
application/json
{
  • "processId": "9e0ad09b-5150-48c0-aded-707587048fd9",
  • "identityIds": [
    ],
  • "commandNameFilter": "string",
  • "culture": "string",
  • "conditionCheck": true
}

Response samples

Content type
application/json
{
  • "availableCommands": [
    ]
}

Execute command with specified identity.

Authorizations:
Bearer
Request Body schema: application/json
required
object (WorkflowCommand)
identityId
string or null
impersonatedIdentityId
string or null
checkRestrictions
boolean

Responses

Request samples

Content type
application/json
{
  • "command": {
    },
  • "identityId": "string",
  • "impersonatedIdentityId": "string",
  • "checkRestrictions": true
}

Response samples

Content type
application/json
{
  • "commandName": "string",
  • "wasExecuted": true,
  • "processInstance": {
    },
  • "message": "string"
}

Get the list of commands available for initial activity and identities.

Authorizations:
Bearer
Request Body schema: application/json
required
schemeCode
string or null
commandNameFilter
string or null
culture
string or null

Responses

Request samples

Content type
application/json
{
  • "schemeCode": "string",
  • "commandNameFilter": "string",
  • "culture": "string"
}

Response samples

Content type
application/json
{
  • "initialCommands": [
    ]
}

RpcInstance

Create instance of the process.

Authorizations:
Bearer
Request Body schema: application/json
required
schemeCode
string or null
processId
string <uuid>
identityId
string or null
impersonatedIdentityId
string or null
calendarName
string or null
Array of objects or null (ProcessParameter)

Responses

Request samples

Content type
application/json
{
  • "schemeCode": "string",
  • "processId": "9e0ad09b-5150-48c0-aded-707587048fd9",
  • "identityId": "string",
  • "impersonatedIdentityId": "string",
  • "calendarName": "string",
  • "initialProcessParameters": [
    ]
}

Response samples

Content type
application/json
{ }

Delete process instance and all child subprocesses.

Authorizations:
Bearer
Request Body schema: application/json
required
processId
string <uuid>

Responses

Request samples

Content type
application/json
{
  • "processId": "9e0ad09b-5150-48c0-aded-707587048fd9"
}

Response samples

Content type
application/json
{ }

Check existence of the process instance.

Authorizations:
Bearer
Request Body schema: application/json
required
processId
string <uuid>

Responses

Request samples

Content type
application/json
{
  • "processId": "9e0ad09b-5150-48c0-aded-707587048fd9"
}

Response samples

Content type
application/json
{
  • "isExists": true
}

Get the root process instance and all subprocesses as a tree.

Authorizations:
Bearer
Request Body schema: application/json
required
processId
string <uuid>

Responses

Request samples

Content type
application/json
{
  • "processId": "9e0ad09b-5150-48c0-aded-707587048fd9"
}

Response samples

Content type
application/json
{
  • "processInstanceTree": {
    }
}

Get the process instance with all parameters.

Authorizations:
Bearer
Request Body schema: application/json
required
processId
string <uuid>

Responses

Request samples

Content type
application/json
{
  • "processId": "9e0ad09b-5150-48c0-aded-707587048fd9"
}

Response samples

Content type
application/json
{
  • "processInstance": {
    }
}

Get the history records for the process instance.

Authorizations:
Bearer
Request Body schema: application/json
required
processId
string <uuid>
object (Paging)

Responses

Request samples

Content type
application/json
{
  • "processId": "9e0ad09b-5150-48c0-aded-707587048fd9",
  • "paging": {
    }
}

Response samples

Content type
application/json
{
  • "history": [
    ]
}

Get the count of history records for the process instance.

Authorizations:
Bearer
Request Body schema: application/json
required
processId
string <uuid>

Responses

Request samples

Content type
application/json
{
  • "processId": "9e0ad09b-5150-48c0-aded-707587048fd9"
}

Response samples

Content type
application/json
{
  • "processHistoryCount": 0
}

Set a new status for the process instance.

Authorizations:
Bearer
Request Body schema: application/json
required
processId
string <uuid>
processStatus
string (ProcessStatusAvailableToSet)
Enum: "Initialized" "Running" "Idled" "Finalized" "Terminated" "Error"
suppressEvent
boolean

Responses

Request samples

Content type
application/json
{
  • "processId": "9e0ad09b-5150-48c0-aded-707587048fd9",
  • "processStatus": "Initialized",
  • "suppressEvent": true
}

Response samples

Content type
application/json
{ }

Get the status of the process instance.

Authorizations:
Bearer
Request Body schema: application/json
required
processId
string <uuid>

Responses

Request samples

Content type
application/json
{
  • "processId": "9e0ad09b-5150-48c0-aded-707587048fd9"
}

Response samples

Content type
application/json
{
  • "processStatus": "Initialized"
}

Delete all subprocesses of the process instance.

Authorizations:
Bearer
Request Body schema: application/json
required
processId
string <uuid>

Responses

Request samples

Content type
application/json
{
  • "processId": "9e0ad09b-5150-48c0-aded-707587048fd9"
}

Response samples

Content type
application/json
{
  • "deletedSubprocessesCount": 0
}

Check if all subprocesses of the process instance are completed.

Authorizations:
Bearer
Request Body schema: application/json
required
processId
string <uuid>

Responses

Request samples

Content type
application/json
{
  • "processId": "9e0ad09b-5150-48c0-aded-707587048fd9"
}

Response samples

Content type
application/json
{
  • "isAllSubprocessesCompleted": true
}

Set the value of a process parameter with persistence purpose.

Authorizations:
Bearer
Request Body schema: application/json
required
processId
string <uuid>
name
string or null
value
any or null

Responses

Request samples

Content type
application/json
{
  • "processId": "9e0ad09b-5150-48c0-aded-707587048fd9",
  • "name": "string",
  • "value": null
}

Response samples

Content type
application/json
{ }

Get the value of a process parameter.

Authorizations:
Bearer
Request Body schema: application/json
required
processId
string <uuid>
name
string or null

Responses

Request samples

Content type
application/json
{
  • "processId": "9e0ad09b-5150-48c0-aded-707587048fd9",
  • "name": "string"
}

Response samples

Content type
application/json
{
  • "name": "string",
  • "value": null
}

RpcLocalization

Get the localized state name for the process instance using the current culture.

Authorizations:
Bearer
Request Body schema: application/json
required
processId
string <uuid>
stateName
string or null

Responses

Request samples

Content type
application/json
{
  • "processId": "9e0ad09b-5150-48c0-aded-707587048fd9",
  • "stateName": "string"
}

Response samples

Content type
application/json
{
  • "localizedStateName": "string"
}

Get the localized state name for the scheme using the current culture.

Authorizations:
Bearer
Request Body schema: application/json
required
schemeId
string <uuid>
stateName
string or null

Responses

Request samples

Content type
application/json
{
  • "schemeId": "d50fd494-6cfc-4f45-83a9-47603a003465",
  • "stateName": "string"
}

Response samples

Content type
application/json
{
  • "localizedStateName": "string"
}

Get the localized state name for the scheme code in the current tenant using the current culture.

Authorizations:
Bearer
Request Body schema: application/json
required
schemeCode
string or null
stateName
string or null

Responses

Request samples

Content type
application/json
{
  • "schemeCode": "string",
  • "stateName": "string"
}

Response samples

Content type
application/json
{
  • "localizedStateName": "string"
}

Get the localized command name for the process instance using the current culture.

Authorizations:
Bearer
Request Body schema: application/json
required
processId
string <uuid>
commandName
string or null

Responses

Request samples

Content type
application/json
{
  • "processId": "9e0ad09b-5150-48c0-aded-707587048fd9",
  • "commandName": "string"
}

Response samples

Content type
application/json
{
  • "localizedCommandName": "string"
}

Get the localized command name for the scheme using the current culture.

Authorizations:
Bearer
Request Body schema: application/json
required
schemeId
string <uuid>
commandName
string or null

Responses

Request samples

Content type
application/json
{
  • "schemeId": "d50fd494-6cfc-4f45-83a9-47603a003465",
  • "commandName": "string"
}

Response samples

Content type
application/json
{
  • "localizedCommandName": "string"
}

RpcLog

Logs a debug message with parameters.

Authorizations:
Bearer
Request Body schema: application/json
required
message
string or null
object or null

Responses

Request samples

Content type
application/json
{
  • "message": "string",
  • "parameters": {
    }
}

Response samples

Content type
application/json
{ }

Logs a debug message with parameters if the logger exists.

Authorizations:
Bearer
Request Body schema: application/json
required
message
string or null
object or null

Responses

Request samples

Content type
application/json
{
  • "message": "string",
  • "parameters": {
    }
}

Response samples

Content type
application/json
{ }

Logs an info message with parameters.

Authorizations:
Bearer
Request Body schema: application/json
required
message
string or null
object or null

Responses

Request samples

Content type
application/json
{
  • "message": "string",
  • "parameters": {
    }
}

Response samples

Content type
application/json
{ }

Logs an info message with parameters if the logger exists.

Authorizations:
Bearer
Request Body schema: application/json
required
message
string or null
object or null

Responses

Request samples

Content type
application/json
{
  • "message": "string",
  • "parameters": {
    }
}

Response samples

Content type
application/json
{ }

Logs an error message with parameters.

Authorizations:
Bearer
Request Body schema: application/json
required
message
string or null
object or null

Responses

Request samples

Content type
application/json
{
  • "message": "string",
  • "parameters": {
    }
}

Response samples

Content type
application/json
{ }

Logs an error message with parameters if the logger exists.

Authorizations:
Bearer
Request Body schema: application/json
required
message
string or null
object or null

Responses

Request samples

Content type
application/json
{
  • "message": "string",
  • "parameters": {
    }
}

Response samples

Content type
application/json
{ }

RpcPreExecution

Pre-execute from the initial activity of the process instance.

Authorizations:
Bearer
Request Body schema: application/json
required
processId
string <uuid>

Responses

Request samples

Content type
application/json
{
  • "processId": "9e0ad09b-5150-48c0-aded-707587048fd9"
}

Response samples

Content type
application/json
{
  • "activitiesSequence": [
    ]
}

Pre-execute from the current activity of the process instance.

Authorizations:
Bearer
Request Body schema: application/json
required
processId
string <uuid>

Responses

Request samples

Content type
application/json
{
  • "processId": "9e0ad09b-5150-48c0-aded-707587048fd9"
}

Response samples

Content type
application/json
{
  • "activitiesSequence": [
    ]
}

Pre-execute from the specified activity of the process instance.

Authorizations:
Bearer
Request Body schema: application/json
required
processId
string <uuid>
fromActivityName
string or null

Responses

Request samples

Content type
application/json
{
  • "processId": "9e0ad09b-5150-48c0-aded-707587048fd9",
  • "fromActivityName": "string"
}

Response samples

Content type
application/json
{
  • "activitiesSequence": [
    ]
}

RpcRuntime

Shuts down the workflow runtime.

Authorizations:
Bearer
Request Body schema: application/json
required
timeout
integer <int32>

Responses

Request samples

Content type
application/json
{
  • "timeout": 0
}

Response samples

Content type
application/json
{ }

Starts the workflow runtime.

Authorizations:
Bearer
Request Body schema: application/json
required
object (RuntimeStartRequest)

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{ }

Starts the workflow runtime in cold start mode.

Authorizations:
Bearer
Request Body schema: application/json
required
object (RuntimeColdStartRequest)

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{ }

Gets the status of the workflow runtime.

Authorizations:
Bearer
Request Body schema: application/json
required
object (RuntimeGetStatusRequest)

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{
  • "runningStatus": "Stopped"
}

RpcScheme

Get scheme codes with optional filtering by tags.

Authorizations:
Bearer
Request Body schema: application/json
required
tags
Array of strings or null

Responses

Request samples

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

Response samples

Content type
application/json
{
  • "schemeCodes": [
    ]
}

Set all process schemes with the specified scheme code as obsolete.

Authorizations:
Bearer
Request Body schema: application/json
required
schemeCode
string or null

Responses

Request samples

Content type
application/json
{
  • "schemeCode": "string"
}

Response samples

Content type
application/json
{ }

Update scheme of the process instance if it is obsolete.

Authorizations:
Bearer
Request Body schema: application/json
required
processId
string <uuid>
ignoreAutoSchemeUpdate
boolean

Responses

Request samples

Content type
application/json
{
  • "processId": "9e0ad09b-5150-48c0-aded-707587048fd9",
  • "ignoreAutoSchemeUpdate": true
}

Response samples

Content type
application/json
{ }

Get the scheme of the process instance.

Authorizations:
Bearer
Request Body schema: application/json
required
processId
string <uuid>

Responses

Request samples

Content type
application/json
{
  • "processId": "9e0ad09b-5150-48c0-aded-707587048fd9"
}

Response samples

Content type
application/json
{
  • "processScheme": {
    }
}

RpcState

Get the list of all available to set states for the process instance.

Authorizations:
Bearer
Request Body schema: application/json
required
processId
string <uuid>
culture
string or null

Responses

Request samples

Content type
application/json
{
  • "processId": "9e0ad09b-5150-48c0-aded-707587048fd9",
  • "culture": "string"
}

Response samples

Content type
application/json
{
  • "availableStates": [
    ]
}

Get the list of all available to set states for the scheme.

Authorizations:
Bearer
Request Body schema: application/json
required
schemeCode
string or null
culture
string or null

Responses

Request samples

Content type
application/json
{
  • "schemeCode": "string",
  • "culture": "string"
}

Response samples

Content type
application/json
{
  • "availableStates": [
    ]
}

Set state for the process instance without execution.

Authorizations:
Bearer
Request Body schema: application/json
required
processId
string <uuid>
stateName
string or null

Responses

Request samples

Content type
application/json
{
  • "processId": "9e0ad09b-5150-48c0-aded-707587048fd9",
  • "stateName": "string"
}

Response samples

Content type
application/json
{ }

Set state for the process instance with execution.

Authorizations:
Bearer
Request Body schema: application/json
required
processId
string <uuid>
identityId
string or null
impersonatedIdentityId
string or null
stateName
string or null
Array of objects or null (ProcessParameter)

Responses

Request samples

Content type
application/json
{
  • "processId": "9e0ad09b-5150-48c0-aded-707587048fd9",
  • "identityId": "string",
  • "impersonatedIdentityId": "string",
  • "stateName": "string",
  • "processParameters": [
    ]
}

Response samples

Content type
application/json
{ }

Set activity for the process instance without execution.

Authorizations:
Bearer
Request Body schema: application/json
required
processId
string <uuid>
activityName
string or null
doNotSetRunningStatus
boolean

Responses

Request samples

Content type
application/json
{
  • "processId": "9e0ad09b-5150-48c0-aded-707587048fd9",
  • "activityName": "string",
  • "doNotSetRunningStatus": true
}

Response samples

Content type
application/json
{ }

Set activity for the process instance with execution.

Authorizations:
Bearer
Request Body schema: application/json
required
processId
string <uuid>
activityName
string or null
Array of objects or null (ProcessParameter)
identityId
string or null
impersonatedIdentityId
string or null
doNotSetRunningStatus
boolean

Responses

Request samples

Content type
application/json
{
  • "processId": "9e0ad09b-5150-48c0-aded-707587048fd9",
  • "activityName": "string",
  • "processParameters": [
    ],
  • "identityId": "string",
  • "impersonatedIdentityId": "string",
  • "doNotSetRunningStatus": true
}

Response samples

Content type
application/json
{ }

Resumes the process instance execution.

Authorizations:
Bearer
Request Body schema: application/json
required
processId
string <uuid>
activityName
string or null
identityId
string or null
impersonatedIdentityId
string or null
Array of objects or null (ProcessParameter)

Responses

Request samples

Content type
application/json
{
  • "processId": "9e0ad09b-5150-48c0-aded-707587048fd9",
  • "activityName": "string",
  • "identityId": "string",
  • "impersonatedIdentityId": "string",
  • "processParameters": [
    ]
}

Response samples

Content type
application/json
{
  • "wasResumed": true,
  • "processInstance": {
    }
}

Get the current state name of the process instance.

Authorizations:
Bearer
Request Body schema: application/json
required
processId
string <uuid>

Responses

Request samples

Content type
application/json
{
  • "processId": "9e0ad09b-5150-48c0-aded-707587048fd9"
}

Response samples

Content type
application/json
{
  • "currentStateName": "string"
}

Get the current activity name of the process instance.

Authorizations:
Bearer
Request Body schema: application/json
required
processId
string <uuid>

Responses

Request samples

Content type
application/json
{
  • "processId": "9e0ad09b-5150-48c0-aded-707587048fd9"
}

Response samples

Content type
application/json
{
  • "currentActivityName": "string"
}

Get the current state of the process instance.

Authorizations:
Bearer
Request Body schema: application/json
required
processId
string <uuid>
culture
string or null

Responses

Request samples

Content type
application/json
{
  • "processId": "9e0ad09b-5150-48c0-aded-707587048fd9",
  • "culture": "string"
}

Response samples

Content type
application/json
{
  • "currentState": {
    }
}

Get the initial state of the scheme.

Authorizations:
Bearer
Request Body schema: application/json
required
schemeCode
string or null
culture
string or null

Responses

Request samples

Content type
application/json
{
  • "schemeCode": "string",
  • "culture": "string"
}

Response samples

Content type
application/json
{
  • "initialState": {
    }
}

Designer

workflow-api.designer.get

Authorizations:
Bearer

Responses

workflow-api.designer

Authorizations:
Bearer

Responses

© 2026 Optimajet Limited. All rights reserved.