Run a workflow

Trigger an execution of a specific version of a workflow.

Securityoidc-token or oauth2-client-credentials or oauth2-open-industrial-data or oauth2-auth-code
Request
path Parameters
workflowExternalId
required
string (WorkflowExternalId) <= 255 characters

Identifier for a workflow. Must be unique for the project. No trailing or leading whitespace and no null characters allowed.

version
required
string (Version) <= 255 characters

Identifier for a version. Must be unique for the workflow. No trailing or leading whitespace and no null characters allowed.

Request Body schema: application/json
required
required
object (Authentication)
input
object (ExecutionInput)

Input data to the workflow. The content of the input data can be used as input to the workflow tasks using references. The input data should be in JSON format, and is limited to 100KB in size.

object (metadata) <= 10 properties

Custom, application-specific metadata. String key -> String value. Keys have a maximum length of 32 characters, values a maximum of 255, and there can be a maximum of 10 key-value pairs.

Responses
202

Information about the workflow execution

post/workflows/{workflowExternalId}/versions/{version}/run
Request samples
application/json
{
  • "authentication": {
    • "nonce": "hOfy4Zop4N2SPRfl"
    },
  • "input": {
    • "key1": "value1",
    • "key2": "value2"
    },
  • "metadata": {
    • "property1": "string",
    • "property2": "string"
    }
}
Response samples
application/json
{
  • "id": "059edaa4-a17a-4102-910e-2c3591500cce",
  • "workflowExternalId": "string",
  • "version": "string",
  • "status": "RUNNING",
  • "engineExecutionId": "stringstringstringstringstringstring",
  • "createdTime": 0,
  • "startTime": 0,
  • "endTime": 0,
  • "reasonForIncompletion": "string",
  • "metadata": {
    • "property1": "string",
    • "property2": "string"
    }
}
➔ Next to Tasks / Update task status