Summary
Export Workflow
Description
Export a single Workflow
Route
POST /workflow_builder/export
Roles
admin
apiread
Parameters
Details Example Schema
Name
Type
Required
Description
options
object
yes
match a workflow using _id or name. Type may be included as an additional filter when using name.
Copied to Clipboard
{
"options": {
"_id": "4321abcdef694aa79dae47ad",
"name": "someWorkflowName",
"type": "ex commodo consequat"
}
}
Copied to Clipboard
{
"type": "object",
"properties": {
"options": {
"type": "object",
"properties": {
"_id": {
"type": "string",
"pattern": "^[0-9a-f]{24}$",
"title": "MongoDB ObjectId",
"description": "Id of Workflow document",
"examples": [
"4321abcdef694aa79dae47ad",
"5cb7b531d06cceb89fd21b1c"
]
},
"name": {
"type": "string",
"description": "The name of the workflow. When provided, 'type' can also be specified for additional filtering.",
"examples": [
"someWorkflowName"
]
},
"type": {
"type": "string",
"description": "The type of the workflow. It is an optional field and is used in conjunction with 'name' for filtering."
}
},
"required": [
"_id",
"name"
],
"oneOf": [
{
"required": [
"_id"
]
},
{
"required": [
"name"
]
}
],
"additionalProperties": false
}
},
"required": [
"options"
],
"additionalProperties": false
}
Return
Details Example Schema
Name
Type
Description
workflow
object
Exported Workflow
Copied to Clipboard
{
"name": "My Workflow",
"type": "automation",
"tasks": {
"workflow_start": {
"name": "workflow_start",
"summary": "workflow_start",
"groups": [
{
"name": "in ad veniam dolore Lorem",
"provenance": "fugiat proident"
}
],
"x": 2452083.4043595344,
"y": -6956693.763229355
},
"workflow_end": {
"name": "workflow_end",
"summary": "workflow_end",
"groups": [
{
"name": "aute",
"provenance": "adipisicing"
}
],
"x": 75592617.9965511,
"y": -11532780.726226032
},
"error_handler": {
"name": "childJob",
"summary": "tempor cillum in",
"description": "ad nulla ex qui sint",
"app": "irure",
"variables": {
"error": "",
"decorators": [
{
"type": "encryption",
"pointer": "/A2gw-uh-n/M.I9od/UwWpQByq/~1/~0/zffwpHy2P2O/Mkl+gX/v"
},
{
"type": "encryption",
"pointer": "/X/~1/~0/G4.lgXhk/r-SxmdB,3f"
},
{
"type": "encryption",
"pointer": "/~1/~0/ib/~1/T./E+9s6xx.-"
}
]
},
"groups": [
{
"name": "fugiat do",
"provenance": "mollit aute esse in ea"
},
{
"name": "quis laborum",
"provenance": "commodo est aliquip cupidatat"
}
],
"x": -98274166.17269652,
"y": 65219153.217020184,
"type": "operation",
"gridCoordinate": {
"x": 99716064.89555672,
"y": 55288306.78999391
},
"deprecated": true,
"scheduled": true
}
},
"transitions": {},
"groups": [
{
"name": "ad",
"provenance": "commodo adipisicing et pariatur"
},
{
"name": "dolore amet",
"provenance": "Lorem consectetur"
},
{
"name": "do",
"provenance": "dolor velit dolore esse"
},
{
"name": "ad eu in nostrud adipisicing",
"provenance": "nulla Ut eu"
},
{
"name": "Excepteur velit",
"provenance": "elit id do esse tempor"
}
],
"_id": "8a09ce44-ccb7-5266-0cc9-52679231c2ca",
"description": null,
"errorHandler": null,
"font_size": 12,
"created": "2009-07-28T07:57:32.883Z",
"created_by": {
"username": "nisi dolore do mollit",
"provenance": "mollit nostrud Lorem sed"
},
"createdVersion": "sit laborum enim ut",
"last_updated": "2001-10-13T09:33:08.062Z",
"last_updated_by": {
"username": "est",
"provenance": "magna"
},
"lastUpdatedVersion": "ut",
"tags": [
{
"_id": "B586Bd65Ba4CedF4FceE11F7",
"name": "cupidatat culpa pariatur",
"description": "dolore"
},
{
"_id": "14F490ecDfA8BFB3CF0beCB7",
"name": "nulla voluptate nisi",
"description": "commodo ut ut proident"
},
{
"_id": "D0B2B15c4fA5DFbB61bF6639",
"name": "aute voluptate fugiat enim",
"description": "eiusmod elit sed quis"
}
],
"canvasVersion": 3,
"encodingVersion": 1,
"decorators": [
{
"type": "encryption",
"pointer": "/oq0C/u/~1/~1/pJ"
}
],
"migrationVersion": 83636292
}