Workflow Repository

Create a new workflow with its initial version.

Changed on
post/workflow-repository/workflows

Request

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

Request body

descriptionstring nullable
namestring
projectIdstring
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].

Example request

{
  "workflowTypeReference": "simscale.cad.data-types:cad-model"
}

Response

Created

string required

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

Example response

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

Changes

    • info

      added entity_assignment_list:function:cad_predicate_failures discriminator mapping keys to the ////// request property

    • info

      added list:function:table_section discriminator mapping keys to the ////// request property