Cognite Data Fusion API

Retrieve a workflow version

Retrieve a version of a given workflow.

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.
version required	string (Version) <= 255 characters Identifier for a version. Must be unique for the workflow. No trailing or leading whitespace and no null characters allowed.

Responses

200

Specific version of a workflow

404

The response for a failed request.

get/workflows/{workflowExternalId}/versions/{version}

Request samples

Python SDK
curl

from cognite.client.data_classes import WorkflowVersionId
res = client.workflows.versions.retrieve(WorkflowVersionId("my_workflow", "v1"))

res = client.workflows.versions.retrieve(
    [WorkflowVersionId("my_workflow", "v1"), WorkflowVersionId("other", "v3.2")],
    ignore_unknown_ids=True,
)
res = client.workflows.versions.retrieve([("my_workflow", "v1"), ("other", "v3.2")])

res = client.workflows.versions.retrieve("my_workflow", "v1")

Response samples

application/json

{"workflowExternalId": "string",
"version": "string",
"workflowDefinition": {"hash": "string",
"description": "string",
"tasks": [{"externalId": "string",
"type": "function",
"name": "string",
"description": "string",
"parameters": {"function": {"externalId": "my.known.id",
"data": {"key1": "value1",
"key2": "value2"
}
},
"isAsyncComplete": false
},
"retries": 3,
"timeout": 3600,
"onFailure": "abortWorkflow",
"dependsOn": [{"externalId": "my.known.id"
}
]
}
]
},
"createdTime": 1730204346000,
"lastUpdatedTime": 1730204346000
}

➔ Next to Workflow executions / Cancel a workflow execution