API reference (20230101-alpha)
workflow = client.workflows.retrieve("my_workflow")
workflow_list = client.workflows.retrieve(["foo", "bar"]){
"externalId": "<string>",
"createdTime": 1730204346000,
"lastUpdatedTime": 1730204346000,
"description": "<string>",
"dataSetId": 4503599627370496,
"maxConcurrentExecutions": 5000
}Retrieve a workflow
Required capabilities:
workflowOrchestrationACL:READ
Retrieve a workflow by its external id.
workflow = client.workflows.retrieve("my_workflow")
workflow_list = client.workflows.retrieve(["foo", "bar"]){
"externalId": "<string>",
"createdTime": 1730204346000,
"lastUpdatedTime": 1730204346000,
"description": "<string>",
"dataSetId": 4503599627370496,
"maxConcurrentExecutions": 5000
}Authorizations
Access token issued by the CDF project's configured identity provider. Access token must be an OpenID Connect token, and the project must be configured to accept OpenID Connect tokens. Use a header key of 'Authorization' with a value of 'Bearer $accesstoken'. The token can be obtained through any flow supported by the identity provider.
Path Parameters
Identifier for a workflow. Must be unique for the project. No trailing or leading whitespace and no null characters allowed.
255Response
Information about the workflow
Identifier for a workflow. Must be unique for the project. No trailing or leading whitespace and no null characters allowed.
255The number of milliseconds since 00:00:00 Thursday, 1 January 1970, Coordinated Universal Time (UTC), minus leap seconds.
x >= 01730204346000
The number of milliseconds since 00:00:00 Thursday, 1 January 1970, Coordinated Universal Time (UTC), minus leap seconds.
x >= 01730204346000
500The unique identifier (ID) of the dataset that this workflow is associated with.
A user must have access to this dataset to perform any actions on the workflow, such as viewing, updating, or deleting it.
Additionally, to manage any resources connected to the workflow (such as triggers, versions, or executions), the user must also have access to the dataset for viewing, updating, creating, and deleting these resources.
1 <= x <= 9007199254740991Maximum concurrent executions for this workflow. Defaults to the project limit if not specified, explicitly set to null, or omitted on update. Values exceeding the project limit are dynamically capped at runtime. The typical project limit ranges from 50 to 200 concurrent executions.
1 <= x <= 10000Was this page helpful?