Retrieve a workflow

Retrieve a workflow by its external id.

Securityoidc-token or oauth2-client-credentials or oauth2-open-industrial-data or oauth2-auth-code
Request
path Parameters
workflowExternalId
required
string (WorkflowExternalId) <= 255 characters

Identifier for a workflow. Must be unique for the project. No trailing or leading whitespace and no null characters allowed.

Responses
200

Information about the workflow

404

The response for a failed request.

get/workflows/{workflowExternalId}
Request samples
workflow = client.workflows.retrieve("my_workflow")

workflow_list = client.workflows.retrieve(["foo", "bar"])
Response samples
application/json
{
  • "externalId": "string",
  • "description": "string",
  • "createdTime": 1730204346000,
  • "lastUpdatedTime": 1730204346000,
  • "dataSetId": 1
}