SIsimscale
Workflow Runner

Read a workflow run.

Changed on
get/workflow-runner/runs/{workflowRunId}

Request

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

Path parameters

workflowRunIdstring required

Response

Ok

creationTimestampstring date-time
hasRecycledOperationboolean
lastProcessedstring date-time
operationRecyclingEnabledboolean
projectIdstring
state'CREATED' | 'VALIDATING' | 'DERIVING_CONNECTIONS' | 'RUNNING' | 'PAUSED' | 'CANCELING' | 'SUCCEEDED' | 'FAILED' | 'CANCELED'

Workflow run state is a higher-level state describing overall progression.

workflowIdstring nullable

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

workflowRunIdstring

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

workflowRunMode'DRY' | 'REAL'
workflowRunNamestring nullable
workflowTypeReferencestring

Reference to a component version.

Components are organized into a group hierarchy which serves as a qualification mechanism to avoid collisions and also to group components semantically.

Component versions follow the convention of semantic versioning.

The fully qualified reference of a component version follows the following syntax: [component_group]:[component]:[component_version].

workflowVersionIdstring nullable

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

Example response

{
  "workflowId": "workflow:3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "workflowRunId": "workflow.run:3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "workflowTypeReference": "simscale.cad.data-types:cad-model",
  "workflowVersionId": "workflow.version:3fa85f64-5717-4562-b3fc-2c963f66afa6"
}

Changes

  • ea89fe74027eRevision changes
    • info

      added the optional property to the response with the status

  • c44a625a8276Revision changes
    • warning

      added the new DERIVING_CONNECTIONS enum value to the response property for the response status