SIsimscale
Workflow Repository

List workflows in a project.

Changed on
get/workflow-repository/projects/{projectId}/workflows

Request

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

Path parameters

projectIdstring required

Query parameters

pageinteger
sizeinteger
sortBystring

Response

Ok

createdByinteger nullable
creationTimestampstring date-time
descriptionstring nullable
lastModificationTimestampstring date-time
namestring
parentWorkflowVersionIdstring nullable

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

projectIdstring
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