Retrieve Workflow Deployment | Vellum

Used to retrieve a workflow deployment given its ID or name.

idstringRequired

Either the Workflow Deployment's ID or its unique name

idstringformat: "uuid"

namestring<=150 characters

A name that uniquely identifies this workflow deployment within its workspace

labelstring<=150 characters

A human-readable label for the workflow deployment

createdstringformat: "date-time"

last_deployed_onstringformat: "date-time"

last_deployed_history_item_idstringformat: "uuid"

The ID of the history item associated with this Workflow Deployment's LATEST Release Tag

input_variableslist of objects

The input variables this Workflow Deployment expects to receive values for when it is executed.

output_variableslist of objects

The output variables this Workflow Deployment produces values for when it's executed.

statusenum or null

The current status of the workflow deployment

Allowed values:

environmentenum or null

The environment this workflow deployment is used in

Allowed values:

descriptionstring or null

A human-readable description of the workflow deployment

1	from vellum import Vellum
2
3	client = Vellum(
4	api_key="YOUR_API_KEY",
5	)
6	client.workflow_deployments.retrieve(
7	id="id",
8	)

1	{
2	"id": "foo",
3	"name": "foo",
4	"label": "foo",
5	"created": "foo",
6	"last_deployed_on": "foo",
7	"last_deployed_history_item_id": "foo",
8	"input_variables": [
9	{
10	"id": "foo",
11	"key": "foo",
12	"type": "STRING",
13	"required": true,
14	"default": {
15	"type": "STRING",
16	"value": "foo"
17	},
18	"extensions": {
19	"color": "foo"
20	}
21	}
22	],
23	"output_variables": [
24	{
25	"id": "foo",
26	"key": "foo",
27	"type": "STRING",
28	"required": true,
29	"default": {
30	"type": "STRING",
31	"value": "foo"
32	},
33	"extensions": {
34	"color": "foo"
35	}
36	}
37	],
38	"status": "ACTIVE",
39	"environment": "DEVELOPMENT",
40	"description": "foo"
41	}