Skip to main content
Skip table of contents

UC Running Workflows


SWAGGER References


Users wishing to start a particular workflow instance can do so via the call under the SWAGGER Reference. However, it is important for the user attempting to perform the call that both the intended workflow's <workflowName> and <workflowVersion> be known.


Performing the POST call starts a new instance of the workflow, while also returning the id for that particular workflow instance in the "location" header. The parameters for the workflow are available in the respective SWAGGER Reference section below.

Path Swagger Reference: Start a Workflow by Name and Version

POST /v1/Instances/{workflowName}/{workflowVersion}

Please note that based on the contract, some parameters can be optional. If the optional parameters are not supplied at the time of the call, their stored default value is used.

JavaScript errors detected

Please note, these errors can depend on your browser setup.

If this problem persists, please contact our support.