Workflow Runner

Initialize a workflow run from a workflow version.

Changed on
post/workflow-runner/runs

Request

  • Base URL
    https://api.simscale.com/v1
  • URL
    https://api.simscale.com/v1/workflow-runner/runs
  • Auth
    API key in header X-API-KEY

Request body

operationRecyclingEnabledboolean
workflowRunMode'DRY' | 'REAL' required
workflowRunNamestring nullable
workflowVersionIdstring required

Workflow version identifier. It is a string composed of the type identifier and a UUID: workflow.version:[UUID].

Example request

{
  "workflowVersionId": "workflow.version:3fa85f64-5717-4562-b3fc-2c963f66afa6"
}

Response

Created

string required

Workflow run identifier. It is a string composed of the type identifier and a UUID: workflow.run:[UUID].

Example response

"workflow.run:3fa85f64-5717-4562-b3fc-2c963f66afa6"

Changes