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": "quis officia ut nulla veniam" } }
{ "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": "ciscoIOSSoftwareUpgrade", "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" } ], "x": 0, "y": 100 }, "workflow_end": { "name": "workflow_end", "summary": "workflow_end", "groups": [ { "name": "Admin", "provenance": "LocalAAA" }, { "name": "Admin", "provenance": "LocalAAA" }, { "name": "Admin", "provenance": "LocalAAA" } ], "x": 0, "y": 1 }, "error_handler": { "name": "Get Device", "summary": "View Data", "description": "View Data", "app": "Tools", "variables": { "error": "", "decorators": [ { "type": "encryption", "pointer": "/outgoing/output" }, { "type": "encryption", "pointer": "/outgoing/output" }, { "type": "encryption", "pointer": "/outgoing/output" }, { "type": "encryption", "pointer": "/outgoing/output" } ] }, "groups": [ { "name": "Admin", "provenance": "LocalAAA" }, { "name": "Admin", "provenance": "LocalAAA" }, { "name": "Admin", "provenance": "LocalAAA" }, { "name": "Admin", "provenance": "LocalAAA" } ], "type": "operation", "x": 0, "y": 100, "deprecated": false, "scheduled": false, "retrySettings": null } }, "transitions": {}, "groups": [ { "name": "Admin", "provenance": "LocalAAA" }, { "name": "Admin", "provenance": "LocalAAA" }, { "name": "Admin", "provenance": "LocalAAA" }, { "name": "Admin", "provenance": "LocalAAA" }, { "name": "Admin", "provenance": "LocalAAA" } ], "_id": "60993055-92c6-9e5f-fc4c-cb1f1969c657", "uuid": "83d5832b-48de-bf50-98a8-9dd9d2a225b0", "description": "Upgrade Cisco IOS device", "namespace": { "type": "project", "_id": "5cb5252a1bbc5a00def564c1", "name": "New Relic", "accessControl": { "read": [ "677c243acf96f9b4484a78ae", "677c243acf96f9b4484a78ae", "677c243acf96f9b4484a78ae", "677c243acf96f9b4484a78ae", "677c243acf96f9b4484a78ae" ], "execute": [ "677c243acf96f9b4484a78ae", "677c243acf96f9b4484a78ae", "677c243acf96f9b4484a78ae", "677c243acf96f9b4484a78ae", "677c243acf96f9b4484a78ae" ], "write": [ "677c243acf96f9b4484a78ae", "677c243acf96f9b4484a78ae", "677c243acf96f9b4484a78ae", "677c243acf96f9b4484a78ae", "677c243acf96f9b4484a78ae" ], "manage": [ "677c243acf96f9b4484a78ae", "677c243acf96f9b4484a78ae", "677c243acf96f9b4484a78ae", "677c243acf96f9b4484a78ae" ] } }, "preAutomationTime": 5000, "sla": -81000451, "errorHandler": { "type": "ea", "name": "mollit" }, "font_size": 12, "created": "2024-03-13T18:21:15.352Z", "created_by": null, "createdVersion": "5.40.5-2021.1.72.0", "last_updated": "2024-03-13T18:21:15.352Z", "last_updated_by": null, "lastUpdatedVersion": "4.69.69", "tags": [ { "_id": "37ED0fFE8cb4E4D617fa0d6b", "name": "voluptate elit", "description": "Excepteur eu adipisicing amet do" }, { "_id": "BB14a422ddd2afFDe650eA65", "name": "consectetur", "description": "voluptate aute anim mollit" }, { "_id": "bc1f2ec2Daacad877C68eD93", "name": "culpa magna consectetur elit", "description": "ut aliqua reprehenderit incididunt culpa" }, { "_id": "32ACBd71bE45dD3b7c7F6AEF", "name": "mollit tempor", "description": "occaecat velit elit enim" }, { "_id": "71f211aC7712Ee2552d78B32", "name": "in veniam aute ipsum dolore", "description": "amet Ut quis" } ], "canvasVersion": 2, "encodingVersion": 1, "decorators": [ { "type": "encryption", "pointer": "/outgoing/output" }, { "type": "encryption", "pointer": "/outgoing/output" }, { "type": "encryption", "pointer": "/outgoing/output" }, { "type": "encryption", "pointer": "/outgoing/output" } ], "migrationVersion": 71987655 }
{ "$ref": "workflowPayload" }