SIsimscale
Workflow Repository

Read a workflow at its latest version.

Changed on
get/workflow-repository/workflows/{workflowId}

Request

  • Base URL
    https://api.simscale.com/v1
  • URL
    https://api.simscale.com/v1/workflow-repository/workflows/{workflowId}
  • Auth
    API key in header X-API-KEY

Path parameters

workflowIdstring required

Response

Ok

createdByinteger nullable
descriptionstring nullable
namestring
origin'CREATED' | 'UPDATED' | 'RESTORED' | 'MIGRATED' | 'COPIED' nullable

The operation through which the workflow version came into existence.

parentWorkflowVersionIdstring nullable

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

projectIdstring
timestampstring date-time
workflowIdstring

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

workflowNamestring
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

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

Example response

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

Changes

  • af5fc28a8067Revision changes
    • info

      added the optional property to the response with the status

  • 494ce2aaf719Revision changes
    • info

      added entity_assignment_list:function:cad_predicate_failures discriminator mapping keys to the ////// response property for the response status