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": "qui" } }
{ "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": "sit occaecat eu esse", "provenance": "in ullamco labore ea dolor" }, { "name": "ullamco", "provenance": "pariatur Excepteur consectetur dolore" }, { "name": "incididunt eu Excepteur dolor sit", "provenance": "culpa" }, { "name": "exercitation magna", "provenance": "aliquip non Ut" }, { "name": "sunt cupidatat Ut", "provenance": "ipsum" } ], "x": -85317751.76305158, "y": -95477142.17361194 }, "workflow_end": { "name": "workflow_end", "summary": "workflow_end", "groups": [ { "name": "officia", "provenance": "anim veniam minim" }, { "name": "mollit", "provenance": "aliquip veniam mollit occaecat aliqua" }, { "name": "Duis ullamco", "provenance": "esse aliqua in qui" }, { "name": "consequat dolore ad esse", "provenance": "labore" }, { "name": "Ut velit irure", "provenance": "et dolor dolor non" } ], "x": 42649779.67983338, "y": 86250394.60891792 }, "error_handler": { "name": "childJob", "summary": "deserunt aute", "description": "nostrud quis in velit", "app": "id dolor sed consectetur dolor", "variables": { "error": "", "decorators": [ { "type": "encryption", "pointer": "/~0/pM/~0/~1/~0/K/UdpQz2/iS/RkVp" }, { "type": "encryption", "pointer": "/gii7l/oFZ/~0/~1/w/M/~0/~1/~0/~1/~1" } ] }, "groups": [ { "name": "velit non Lorem veniam", "provenance": "elit" }, { "name": "sed cillum", "provenance": "occaecat aliquip" }, { "name": "cillum dolore velit elit in", "provenance": "ut dolor consequat nostrud" } ], "x": 78059771.43501371, "y": 65843479.45105794, "type": "operation", "gridCoordinate": { "x": 90920950.7300112, "y": -86841334.11447367 }, "deprecated": true, "scheduled": true } }, "transitions": {}, "groups": [ { "name": "ea", "provenance": "anim Duis ipsum id aliquip" }, { "name": "incididunt", "provenance": "culpa aute cupidatat" }, { "name": "commodo eu tempor voluptate", "provenance": "est" }, { "name": "cillum proident magna velit dolor", "provenance": "in Duis" }, { "name": "esse Duis mollit", "provenance": "tempor qui nostrud Lorem" } ], "_id": "848dcfe7-2f8a-2abc-2602-6af06415ca42", "description": null, "namespace": { "type": "project", "_id": "5cb5252a1bbc5a00def564c1", "name": "officia", "accessControl": { "read": [ "cupidatat tempor sint", "quis", "sit nostrud ad", "sint in", "Excepteur proident exercitation cupidatat aute" ], "execute": [ "aute deserunt", "deserunt" ], "write": [ "in Excepteur", "velit" ], "manage": [ "ea", "fugiat do", "ad quis" ] } }, "errorHandler": null, "font_size": 12, "created": "1970-04-19T06:56:11.489Z", "created_by": { "username": "Ut consequat sed culpa aliquip", "provenance": "enim non tempor" }, "createdVersion": "ex", "last_updated": "2002-08-30T21:11:21.529Z", "last_updated_by": { "username": "non ut est sit tempor", "provenance": "dolore" }, "lastUpdatedVersion": "exercitation tempor", "tags": [ { "_id": "8cfD78CBDF3C2A3Cc51b010d", "name": "incididunt ad Excepteur nisi", "description": "exercitation incididunt" }, { "_id": "3b37f2C0A1FdFabFFE5308f6", "name": "ullamco irure in sint ad", "description": "incididunt" }, { "_id": "Aff46e5cCbfaafF1Af9FCdD7", "name": "enim", "description": "nulla deserunt" }, { "_id": "4BDBc8FAE4Cbb1eE83CCf4d4", "name": "fugiat minim", "description": "ea ullamco aliqua" }, { "_id": "48bf60F0CFAeC0735Fb173CA", "name": "mollit anim Lorem eiusmod", "description": "pariatur nisi in" } ], "canvasVersion": 3, "encodingVersion": 1, "decorators": [ { "type": "encryption", "pointer": "/AFktZisL/mfMK/juD9uC/~0/~0" }, { "type": "encryption", "pointer": "/~1/GZb/~1/~0" }, { "type": "encryption", "pointer": "/~0/lHck/B3e/~1/~1/M6E6UZCX/~0/g" }, { "type": "encryption", "pointer": "/aqF9dhnKDCf/h/Lt6DtfifX/lJrbzYefZ/~0/SLL/DmruFg68/Z4-bnZU/~1/xH/~0" } ], "migrationVersion": 25870645 }
{ "$ref": "workflowPayload" }