Summary
Export Workflow
Description
Export a single Workflow
Route
POST /workflow_builder/export
Roles
Parameters
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. |
{ "options": { "_id": "4321abcdef694aa79dae47ad", "name": "someWorkflowName", "type": "sit sint cillum et" } }
{ "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
Name | Type | Description |
---|---|---|
workflow | object | Exported Workflow |
{ "name": "My Workflow", "type": "automation", "tasks": { "workflow_start": { "name": "workflow_start", "summary": "workflow_start", "groups": [ { "name": "ipsum esse reprehenderit", "provenance": "do ex aute nostrud laboris" }, { "name": "tempor laborum", "provenance": "fugiat ea veniam dolore consectetur" }, { "name": "culpa pariatur", "provenance": "cupidatat laborum Excepteur" }, { "name": "occaecat dolore", "provenance": "dolor" } ], "x": 58256728.9154993, "y": -22361756.087838322 }, "workflow_end": { "name": "workflow_end", "summary": "workflow_end", "groups": [ { "name": "culpa", "provenance": "enim ex esse exercitation laboris" }, { "name": "enim Lorem", "provenance": "in ad est et" } ], "x": 72858386.1284016, "y": -81596185.63528 }, "error_handler": { "name": "childJob", "summary": "enim", "description": "esse occaecat ad enim", "app": "sed Lorem", "variables": { "error": "", "decorators": [ { "type": "encryption", "pointer": "/GUICTLeUqS/Wl+/~0/nY35VT/~0/hg/JKA/YMg62fPKns/bZ8/~1/~0" }, { "type": "encryption", "pointer": "/lMupiM/~1/~1/tW" }, { "type": "encryption", "pointer": "/B2BF/bv/~0/~0/i/~0/~1/qQ1-U/BqhgkY.Hfv/kNIZMb/B0vwr" }, { "type": "encryption", "pointer": "/WKZGWk/~1" }, { "type": "encryption", "pointer": "/~1/Ansliwrpf/~1/~0/Wh,PtH5K./~0/~0/f.Q/j/~1/~1" } ] }, "groups": [ { "name": "dolore amet pariatur", "provenance": "ipsum labore laboris" }, { "name": "reprehenderit mollit enim culpa in", "provenance": "labore" }, { "name": "et eiusmod", "provenance": "magna Lorem nisi" }, { "name": "enim anim", "provenance": "commodo elit" } ], "x": 48875045.45412463, "y": 82788023.36561245, "type": "operation", "gridCoordinate": { "x": 92804205.44721988, "y": 58569252.07315394 }, "deprecated": true, "scheduled": false } }, "transitions": {}, "groups": [ { "name": "Lorem", "provenance": "Lorem esse" }, { "name": "ullamco", "provenance": "laboris" }, { "name": "elit", "provenance": "veniam aute eiusmod elit" }, { "name": "culpa ullamco velit", "provenance": "ea magna id" }, { "name": "dolor occaecat", "provenance": "ea laborum amet culpa sint" } ], "_id": "73f3b008-a9ea-a7b6-ba2f-f17d826efcc4", "description": "cupidatat", "namespace": { "type": "project", "_id": "5cb5252a1bbc5a00def564c1", "name": "Lorem aliquip magna in", "accessControl": { "read": [ "esse ipsum" ], "execute": [ "sit nisi minim" ], "write": [ "aliquip dolore" ], "manage": [ "incididunt consequat amet", "dolor", "mollit cillum", "eu nisi" ] } }, "errorHandler": null, "font_size": 12, "created": "1958-03-07T02:39:41.817Z", "created_by": { "username": "labore nulla Duis", "provenance": "consectetur est" }, "createdVersion": "officia Ut ex", "last_updated": "1967-11-01T18:11:04.233Z", "last_updated_by": { "username": "consectetur sed anim", "provenance": "dolor cillum occaecat ullamco sunt" }, "lastUpdatedVersion": "Duis ea nostrud", "tags": [ { "_id": "4EC6dFa7D8a6190cBf8Fc69B", "name": "enim nisi deserunt", "description": "quis irure eiusmod id ullamco" }, { "_id": "bD31FFC56FEF11BAbEbe0AEf", "name": "commodo", "description": "deserunt dolore minim" }, { "_id": "FbbA1ABFbAd5f3F9E7Ab452a", "name": "id mollit reprehenderit", "description": "ut deserunt ullamco" }, { "_id": "9c5d9EF811c07B75c8C9bDec", "name": "in cupidatat", "description": "nulla ipsum incididunt Duis sunt" } ], "canvasVersion": 3, "encodingVersion": 1, "decorators": [ { "type": "encryption", "pointer": "/etDS/~1" }, { "type": "encryption", "pointer": "/Pqng/j9/Bg/~0/q7" } ], "migrationVersion": 24355612 }
{ "$ref": "workflowPayload" }