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": "sed Ut amet irure" } }
{ "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": "Ut", "provenance": "ex" }, { "name": "ad", "provenance": "esse in" }, { "name": "Ut laborum", "provenance": "nostrud sed mollit nulla laboris" }, { "name": "adipisicing nostrud sint aute magna", "provenance": "exercitation amet" }, { "name": "cillum nisi", "provenance": "qui culpa" } ], "x": -7197174.772669032, "y": -35499872.06419325 }, "workflow_end": { "name": "workflow_end", "summary": "workflow_end", "groups": [ { "name": "est Ut veniam laboris", "provenance": "commodo enim" }, { "name": "in", "provenance": "consequat aute mollit quis" }, { "name": "eiusmod laborum", "provenance": "laborum in Ut commodo" }, { "name": "dolor Duis Lorem voluptate", "provenance": "in dolore officia amet nulla" } ], "x": 67198012.6233285, "y": 32577998.28115408 }, "error_handler": { "name": "childJob", "summary": "dolore in aliqua", "description": "in deserunt exercitation minim id", "app": "id exercitation est laborum reprehenderit", "variables": { "error": "", "decorators": [ { "type": "encryption", "pointer": "/D9CH/~1/Dx/MD/ULc/~0/~0/~1/~0/~0" }, { "type": "encryption", "pointer": "/svSPLM/~0/uekTcKKEEqQ/pGnMEeB/VuaDT-UWqm/~1/vzI5S/~0/slV,.3yD" }, { "type": "encryption", "pointer": "/~1/Xhx/~0" }, { "type": "encryption", "pointer": "/m/~1/gQj0UtQPHRO/fsO/~1/zs77" } ] }, "groups": [ { "name": "nostrud ipsum eiusmod ad", "provenance": "mollit" }, { "name": "sit Ut cupidatat in do", "provenance": "sunt" }, { "name": "aliqua ipsum ut", "provenance": "qui" }, { "name": "occaecat dolore aliqua velit non", "provenance": "officia" }, { "name": "eiusmod sunt", "provenance": "Ut ex magna ut non" } ], "x": -72764526.83261745, "y": 95043902.50248885, "type": "operation", "gridCoordinate": { "x": 35890407.985955, "y": 26116100.47486396 }, "deprecated": false, "scheduled": true } }, "transitions": {}, "groups": [ { "name": "esse labore elit", "provenance": "reprehenderit adipisicing" }, { "name": "dolor irure qui cillum", "provenance": "dolore" }, { "name": "consectetur consequat quis aliqua", "provenance": "Ut amet in dolor dolore" }, { "name": "ipsum esse nulla ex dolor", "provenance": "Excepteur" } ], "_id": "f5aebbca-63a9-fd72-7781-3a74f1f4a7b0", "description": "dolore Duis Lorem laboris magna", "namespace": { "type": "project", "_id": "5cb5252a1bbc5a00def564c1", "name": "proident sint", "accessControl": { "read": [ "in pariatur sed aute non" ], "execute": [ "est reprehenderit laborum elit qui", "ea laborum elit" ], "write": [ "consectetur", "est dolore deserunt magna ut", "esse ut in", "sunt anim" ], "manage": [ "in enim", "pariatur adipisicing do incididunt", "Duis commodo enim ullamco Lorem", "quis eu aute" ] } }, "errorHandler": null, "font_size": 12, "created": "1954-10-21T23:10:01.219Z", "created_by": { "username": "sit non", "provenance": "incididunt exercitation" }, "createdVersion": "exercitation dolore tempor sunt cillum", "last_updated": "2007-08-29T04:58:48.46Z", "last_updated_by": { "username": "nostrud", "provenance": "adipisicing nulla dolore sit cupidatat" }, "lastUpdatedVersion": "dolor", "tags": [ { "_id": "c199Ef619b1fb25EE2Ff16ab", "name": "consectetur ad elit sed", "description": "occaecat" }, { "_id": "CcAAd6c7C66bFfdE9BFcBEEE", "name": "dolor", "description": "occaecat dolore cupidatat Duis" }, { "_id": "0cFc1dAb8bcdeBc5aadE083b", "name": "nulla irure labore aliquip", "description": "in nostrud aliquip Excepteur ullamco" } ], "canvasVersion": 1.5, "encodingVersion": 1, "decorators": [ { "type": "encryption", "pointer": "/BKoUt3/~1/PJiHrSj/~1/~1/lhtl+rFue/~0/rG/~1/~0/pAH,w" } ], "migrationVersion": 43379472 }
{ "$ref": "workflowPayload" }