SIsimscale
Workflow Runner

Read an operation run.

Changed on
get/workflow-runner/operation-runs/{operationRunId}

Request

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

Path parameters

operationRunIdstring required

Response

Ok

methodReferencestring nullable

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].

methodRunIdstring nullable

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

nestedWorkflowRunIdstring nullable

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

nestedWorkflowTypeReferencestring nullable

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].

operationNamestring
operationRunIdstring

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

operationType'METHOD' | 'NESTED_WORKFLOW' | 'INLINE'

Possible types of an operation run in the workflow run.

parameterValuesobject nullable
recycledboolean
workflowRunIdstring

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

Example response

{
  "methodReference": "simscale.cad.data-types:cad-model",
  "methodRunId": "method.run:3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "nestedWorkflowRunId": "workflow.run:3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "nestedWorkflowTypeReference": "simscale.cad.data-types:cad-model",
  "operationRunId": "operation.run:3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "recycledFrom": {
    "methodRunId": "method.run:3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "nestedWorkflowRunId": "workflow.run:3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "operationRunId": "operation.run:3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "workflowRunId": "workflow.run:3fa85f64-5717-4562-b3fc-2c963f66afa6"
  },
  "workflowRunId": "workflow.run:3fa85f64-5717-4562-b3fc-2c963f66afa6"
}

Changes