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": "5cb7b531d06cceb89fd21b1c", "name": "someWorkflowName", "type": "ut nisi" } }
{ "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": "Admin", "provenance": "LocalAAA" }, { "name": "Admin", "provenance": "LocalAAA" }, { "name": "Admin", "provenance": "LocalAAA" }, { "name": "Admin", "provenance": "LocalAAA" }, { "name": "Admin", "provenance": "LocalAAA" } ], "nodeLocation": { "x": 65090914.496687055, "y": 27684864.782759085 } }, "workflow_end": { "name": "workflow_end", "summary": "workflow_end", "groups": [ { "name": "Admin", "provenance": "LocalAAA" }, { "name": "Admin", "provenance": "LocalAAA" }, { "name": "Admin", "provenance": "LocalAAA" }, { "name": "Admin", "provenance": "LocalAAA" } ], "x": 0, "y": 1 }, "error_handler": { "name": "Transformation", "summary": "JSON Transformation", "description": "Query Data Using 'json-query' Format", "app": "Tools", "variables": { "error": "", "decorators": [ { "type": "encryption", "pointer": "/outgoing/output" }, { "type": "encryption", "pointer": "/outgoing/output" } ] }, "groups": [ { "name": "Admin", "provenance": "LocalAAA" }, { "name": "Admin", "provenance": "LocalAAA" }, { "name": "Admin", "provenance": "LocalAAA" } ], "type": "operation", "x": 0, "y": 100, "deprecated": false, "scheduled": true, "retrySettings": { "state": [ "success", "failure" ], "autoRetry": true, "limit": 20, "delay": 1000, "count": 5 } } }, "transitions": {}, "groups": [ { "name": "Admin", "provenance": "LocalAAA" }, { "name": "Admin", "provenance": "LocalAAA" } ], "_id": "9b4151e0-c434-b61d-7d38-d047c9cc54a6", "uuid": "c1752b7d-9cab-b58d-7660-55d226d2bbaa", "description": "Upgrade Cisco IOS device", "namespace": { "type": "project", "_id": "5cb5252a1bbc5a00def564c1", "name": "Cisco", "accessControl": { "read": [ "677c243acf96f9b4484a78ae", "677c243acf96f9b4484a78ae", "677c243acf96f9b4484a78ae", "677c243acf96f9b4484a78ae", "677c243acf96f9b4484a78ae" ], "execute": [ "677c243acf96f9b4484a78ae", "677c243acf96f9b4484a78ae", "677c243acf96f9b4484a78ae", "677c243acf96f9b4484a78ae", "677c243acf96f9b4484a78ae" ], "write": [ "677c243acf96f9b4484a78ae", "677c243acf96f9b4484a78ae", "677c243acf96f9b4484a78ae", "677c243acf96f9b4484a78ae" ], "manage": [ "677c243acf96f9b4484a78ae" ] } }, "preAutomationTime": 5000, "sla": 65431336, "errorHandler": { "type": "proident", "name": "amet" }, "font_size": 12, "created": "2024-03-13T18:21:15.352Z", "created_by": { "username": "admin@pronghorn", "provenance": "LocalAAA" }, "createdVersion": "5.40.5-2021.1.72.0", "last_updated": "2024-03-13T18:21:15.352Z", "last_updated_by": { "username": "admin@pronghorn", "provenance": "LocalAAA" }, "lastUpdatedVersion": "4.69.69", "tags": [ { "_id": "f6bE99Ee16DEaF7d1ADd320a", "name": "veniam", "description": "proident" }, { "_id": "833CCf7eC1EdA20A9A39fefd", "name": "commodo non", "description": "esse exercitation sit ex tempor" }, { "_id": "687D3a20EC3AEE0e14D30B81", "name": "deserunt nostrud sed", "description": "sunt dolor" }, { "_id": "03E07C2128E86Be4d4df9756", "name": "aliqua", "description": "laboris officia cupidatat" }, { "_id": "BdC7E2b7DbCb4FbeC0BD9C01", "name": "nulla irure incididunt ut cillum", "description": "labore in amet do" } ], "canvasVersion": 3, "encodingVersion": 1, "decorators": [ { "type": "encryption", "pointer": "/outgoing/output" }, { "type": "encryption", "pointer": "/outgoing/output" }, { "type": "encryption", "pointer": "/outgoing/output" }, { "type": "encryption", "pointer": "/outgoing/output" } ], "migrationVersion": 10012189 }
{ "$ref": "workflowPayload" }