Summary
Start a Job
Description
Spawns a Job from a Workflow.
Route
POST /operations-manager/jobs/start
Roles
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| workflow | string | yes | The name of the workflow from which to start the Job. |
| options | object | yes | Options for the Job. |
{ "workflow": "ad non id aliquip", "options": { "description": "Example job description", "type": "automation", "groups": [ "308bd82a2358f92debc88867", "df0e43ec74f3fdcdfdbb3b63", "d2df4cf8dfff63074894b7fe", "77c186d2db554801dada3402" ] } }
{ "type": "object", "properties": { "workflow": { "title": "workflow", "type": "string" }, "options": { "title": "options", "type": "object", "properties": { "description": { "type": "string", "description": "The description for the new Job.", "examples": [ "Example job description" ] }, "type": { "type": "string", "examples": [ "automation" ] }, "variables": { "type": "object", "description": "Variables for the new Job.", "additionalProperties": true }, "groups": { "type": "array", "description": "GBAC for the new Job.", "items": { "$ref": "common#/definitions/ObjectIdLikeString" } } } } }, "required": [ "workflow", "options" ], "additionalProperties": false }
Return
| Name | Type | Description |
|---|---|---|
| job | object | The spawned Job. |
{ "message": "Successfully imported 3 of 4 documents", "data": { "_id": "b2c44124f6f489604e67c9e3", "uuid": "60aec836-584c-8896-1f47-46911f1b3c55", "font_size": 88739370, "type": "automation", "created": "2018-12-09T00:28:33.816Z", "last_updated": "2000-06-27T07:27:43.454Z", "createdVersion": "0716403.5914362.80-6403.45.05700463957.8203103243", "lastUpdatedVersion": "12.6176629.1385-0485.0768244.6637458807.8508806952", "canvasVersion": 1.5, "encodingVersion": 1, "migrationVersion": 46967426, "name": "myCoolDocumentName", "description": "Some helpful information about the document", "preAutomationTime": 99100666.66813827, "sla": -48579525.73664739, "decorators": [ { "type": "encryption", "pointer": "/Z1X2/~1/aSXXU-8/ydT//DMq8/YdHD6E/~0/~0/~0/vAovR+fT+/CxfdnPW" }, { "type": "encryption", "pointer": "/~1/~0/~0/owpP8L40L6N/ycaPWR5h/EQT/~1" }, { "type": "encryption", "pointer": "/FB+H-gCvGQ,/~0/~1" }, { "type": "encryption", "pointer": "/m/nkqP3.sH/y.9Dmi/~0/u/bv/VjxMcxF/~1/xwUhEA9/xQGiZ8" } ], "status": "canceled", "tags": [], "error": [ { "task": "f9a9", "message": { "code": 500, "message": { "apiVersion": "1", "method": "transformations.run", "error": { "code": 500, "message": "Missing one of the following required instances: arg2, arg1", "errors": [] } } }, "timestamp": 1627323002561 } ], "warnings": [ { "task": "error_handler", "name": "myCoolDocumentName" }, { "task": "workflow_start", "name": "myCoolDocumentName", "message": "culpa eiusmod" }, { "task": "workflow_start", "name": "myCoolDocumentName" }, { "task": "workflow_start", "name": "myCoolDocumentName", "message": "qui sint" } ], "ancestors": null, "validationErrors": [ { "keyword": "Lorem voluptate minim exercitation pariatur", "instancePath": "est magna voluptate sit", "schemaPath": "reprehenderit", "message": "proident eiusmod sunt" } ], "created_by": "Pronghorn", "last_updated_by": "774366f16986bb3199b0eec3", "tasks": { "workflow_start": { "x": -26917730.425544575, "y": -29431430.275152564, "gridCoordinate": { "x": -49914420.14102643, "y": -36794355.632795826 }, "name": "workflow_start", "summary": "workflow_start", "taskId": "workflow_start", "metrics": { "start_time": -80345265.30535594, "finish_state": "success", "user": "c8a1b1a3a3e3f0d3e1e9ec6b" }, "groups": [ "default" ], "iterations": [ "7EC8DcFa-778C-57F3-575e-8e76B0C4F3ca" ] }, "workflow_end": { "x": -31127318.451789156, "y": 86596915.57140493, "gridCoordinate": { "x": -42846491.78011928, "y": 59069053.52386436 }, "name": "workflow_end", "summary": "workflow_end", "taskId": "workflow_end", "endTasks": { "incomplete": [ "e28f", "workflow_start", "error_handler", "workflow_start", "workflow_start" ], "complete": [ "workflow_end" ], "error": [ "e28f", "workflow_start", "3a1f" ] }, "metrics": { "end_time": 89391094.63218436, "run_time": -27686691.136058927 }, "groups": [ "1f31b890b3ade48819e9658a" ], "iterations": [] }, "error_handler": { "x": -28634158.96074733, "y": -85374953.6755807, "gridCoordinate": { "x": 79221855.85855487, "y": -68389108.20157343 }, "name": "childJob", "location": "Broker", "locationType": null, "app": "ut sit consectetur sed qui", "canvasName": "veniam dolor", "displayName": "elit nostrud consectetur eu", "summary": "do", "description": "dolor enim", "variables": { "error": "", "decorators": [ { "type": "encryption", "pointer": "/mRiy/g2/~0/hjXyoOp/y2KtQ4E" }, { "type": "encryption", "pointer": "/~1/~1/A" }, { "type": "encryption", "pointer": "/jyEP/R6/~1" } ] }, "deprecated": false, "scheduled": false, "matched": [ { "key": "reprehenderit ipsum esse", "highlightString": "cillum Excepteur est" }, { "key": "aute sunt dolor pariatur dolore", "highlightString": "in cillum" }, { "key": "Ut mollit", "highlightString": "magna elit deserunt non voluptate" }, { "key": "in adipisicing", "highlightString": "Ut magna officia" }, { "key": "minim nisi", "highlightString": "mollit esse" } ], "status": "paused", "previous": { "incomplete": [ "workflow_end", "workflow_start", "e28f" ], "complete": [ "workflow_start", "workflow_start", "workflow_end", "error_handler", "workflow_start" ], "error": [ "error_handler" ] }, "taskId": "workflow_end", "transitions": { "success": [ { "task": "workflow_start", "type": "standard" }, { "task": "workflow_start", "type": "standard" } ], "failure": [ { "task": "e28f", "type": "standard" }, { "task": "3a1f", "type": "revert" }, { "task": "workflow_end", "type": "loop" }, { "task": "3a1f", "type": "standard" }, { "task": "error_handler", "type": "standard" } ], "error": [ { "task": "workflow_start", "type": "loop" }, { "task": "workflow_start", "type": "loop" }, { "task": "workflow_start", "type": "standard" } ] }, "serverId": "ut dolore ad", "start_time": "1963-08-20T01:50:39.481Z", "end_time": -9719897.431146458, "finish_state": "failure", "retrySettings": null, "type": "operation", "actor": "77a470a484702063dc8156d7", "groups": [ "582a2022743f25abdb1fcf58", "default" ], "iterations": [] }, "c": { "actor": "$var.3.NTY", "groups": [ "f1e7e4f5ff5c6369d5870aae", { "_id": "4cfbc54445326f8ef9fb658d", "provenance": "magna qui nostrud", "name": "exercitation est dolore quis enim", "description": "dolor", "memberOf": [ { "groupId": "907b88aad71533ac414b83a8", "aaaManaged": false }, { "groupId": "20e9714fcff1d18de543ee44", "aaaManaged": false }, { "groupId": "d31126ecbd95370c0f0acee1", "aaaManaged": true }, { "groupId": "6bf006c9d81de4f975959b48", "aaaManaged": true }, { "groupId": "141bae0548f27abe7b6ef008", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "irure tempor sint ea" }, { "roleId": "sed cillum in" } ], "inactive": false, "_meta": { "created": "1997-06-02T01:00:50.816Z", "updated": "1992-12-19T01:34:07.873Z", "migrationVersion": 76378008 } }, "default" ], "iterations": [ "16648b6a-732e-8dA1-C93A-bb7BfAc20aF9" ], "x": -91111605.77392234, "y": 96856461.87134287, "gridCoordinate": { "x": 76168371.922894, "y": 80270424.85755768 }, "name": "cupidatat in", "location": "Application", "locationType": "elit ut", "app": "quis anim consectetur", "canvasName": "pariatur aliqua ea sint", "displayName": "Ut id commodo ea irure", "summary": "in mollit", "description": "Lorem veniam voluptate in deserunt", "variables": { "error": "", "decorators": [ { "type": "encryption", "pointer": "/SLmF9-s3/~0/~0/UDbgUQ/~1/~1/oNH/~0/yAvt/p2Z5rSj" } ] }, "deprecated": true, "scheduled": false, "matched": [ { "key": "enim ipsum", "highlightString": "irure anim" }, { "key": "elit", "highlightString": "culpa veniam nostrud" }, { "key": "consequat", "highlightString": "irure eu" }, { "key": "Ut exercitation laborum", "highlightString": "sit Lorem" } ], "status": "paused", "previous": { "incomplete": [ "error_handler", "3a1f", "e28f", "error_handler" ], "complete": [ "workflow_end", "workflow_start", "error_handler", "error_handler", "e28f" ], "error": [ "3a1f" ] }, "taskId": "workflow_start", "transitions": { "success": [ { "task": "3a1f", "type": "loop" }, { "task": "error_handler", "type": "revert" }, { "task": "workflow_start", "type": "standard" }, { "task": "3a1f", "type": "loop" }, { "task": "workflow_start", "type": "loop" } ], "failure": [ { "task": "error_handler", "type": "standard" }, { "task": "e28f", "type": "standard" }, { "task": "workflow_end", "type": "revert" } ], "error": [ { "task": "workflow_end", "type": "loop" }, { "task": "workflow_end", "type": "revert" } ] }, "serverId": "Ut ipsum aute Excepteur", "start_time": "2014-10-08T12:20:09.401Z", "end_time": 70359223.26511747, "finish_state": "failure", "retrySettings": { "state": [ "error", "error", "error", "error" ], "autoRetry": true, "limit": 54584377, "delay": 36510652, "count": 53819267, "finishedRetrying": false }, "type": "automatic" } }, "parent": { "task": "esse ut quis", "iteration": -13696680.99746275, "element": 18058114.59441556 }, "errorHandler": { "actor": "job", "groups": [ { "_id": "9db04011c8b280d4afc05622", "provenance": "ipsum dolor Lorem do esse", "name": "anim deserunt", "description": "ex sint reprehenderit", "memberOf": [ { "groupId": "ccff8c0a824e470138b4ba39", "aaaManaged": true }, { "groupId": "b434af201a3f6bc3b3da718f", "aaaManaged": false }, { "groupId": "93107023b9529967ee6ca46a", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "non nulla enim" }, { "roleId": "dolor irure" }, { "roleId": "culpa minim" }, { "roleId": "consequat sed mollit" }, { "roleId": "commodo anim amet nisi irure" } ], "inactive": true, "_meta": { "created": "1965-12-12T22:25:44.701Z", "updated": "1976-12-14T00:27:06.8Z", "migrationVersion": 12050597 } } ], "iterations": [], "x": 98912316.8283948, "y": 74005011.97865635, "gridCoordinate": { "x": -3010281.5717556924, "y": -85343336.06732906 }, "name": "incididunt nulla", "location": "Broker", "locationType": null, "app": "occaecat voluptate", "canvasName": "adipisicing", "displayName": "ea", "summary": "Ut aliqua", "description": "in amet aliqua anim", "variables": { "error": "", "decorators": [ { "type": "encryption", "pointer": "/~1/OCwsr.Kb15/~1/w/~1/f1T" }, { "type": "encryption", "pointer": "/~0" }, { "type": "encryption", "pointer": "/tKl9keX/~0/~0/~0/b4ltZd" } ] }, "deprecated": false, "scheduled": false, "matched": [ { "key": "in do eiusmod", "highlightString": "exercitation qui esse nostrud" }, { "key": "dolor minim labore", "highlightString": "exercitation" }, { "key": "officia elit aliquip occaecat cillum", "highlightString": "magna aliqua qui cillum" } ], "status": "complete", "previous": { "incomplete": [ "3a1f", "3a1f", "workflow_start", "workflow_start", "workflow_start" ], "complete": [ "e28f", "workflow_start", "3a1f" ], "error": [ "workflow_start", "workflow_start" ] }, "taskId": "workflow_start", "transitions": { "success": [ { "task": "workflow_end", "type": "loop" }, { "task": "workflow_start", "type": "loop" }, { "task": "workflow_start", "type": "standard" }, { "task": "workflow_start", "type": "revert" } ], "failure": [ { "task": "workflow_start", "type": "loop" } ], "error": [ { "task": "workflow_end", "type": "revert" }, { "task": "workflow_end", "type": "standard" }, { "task": "workflow_start", "type": "revert" }, { "task": "workflow_start", "type": "revert" } ] }, "serverId": "ullamco dolore", "start_time": "1958-09-09T08:35:55.167Z", "end_time": -32388131.282396287, "finish_state": "failure", "retrySettings": { "state": [ "error", "success", "failure", "failure" ], "autoRetry": true, "limit": 54955565, "delay": 83236596, "count": 22537045, "finishedRetrying": false }, "type": "automatic" }, "groups": [ "56305220c2a4a018ed26d680", { "_id": "b37cdd6f12ab4a6756632444", "provenance": "ex sunt magna occaecat ipsum", "name": "mollit est dolor ea", "description": "in nulla", "memberOf": [ { "groupId": "15d4f26f283b974981afc83e", "aaaManaged": true }, { "groupId": "3828f41ecc95a61312207336", "aaaManaged": false }, { "groupId": "db74b0556e27d354743250da", "aaaManaged": false }, { "groupId": "b9ec9f9f59bdafe5702c02c5", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "officia dolore" }, { "roleId": "sed ipsum amet ad" } ], "inactive": false, "_meta": { "created": "1997-03-19T21:27:34.545Z", "updated": "2009-07-18T11:30:45.834Z", "migrationVersion": 78751101 } } ], "watchers": [ "14c116208f8560c85681a117", { "_id": "5d1c98b9dc7178e8b17f22ba", "provenance": "fugiat id Ut", "username": "laborum", "firstname": "amet commodo exercitation dolor in", "memberOf": [ { "groupId": "88d7129193b6dc8be684c089", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "ipsum mollit velit" }, { "roleId": "exercitation ad sed ea" }, { "roleId": "qui exercitation in enim" }, { "roleId": "voluptate reprehenderit in fugiat" }, { "roleId": "Lorem" } ], "inactive": false, "lastLogin": "1966-03-03T08:36:53.353Z", "_meta": { "created": "1953-05-31T02:48:23.23Z", "updated": "1993-04-25T11:41:16.029Z", "migrationVersion": -85813890 }, "email": "laboris minim" }, "Pronghorn", null ], "metrics": { "start_time": -44513085.71479546, "progress": 0.8344904285422858, "end_time": -34132557.46276964, "user": "6f94a54d010cbe7a0d146cad", "owner": "f8be839e8a17ef2b5828323b" } } }
{ "title": "job", "allOf": [ { "$ref": "common-api#/definitions/success-response" }, { "type": "object", "properties": { "data": { "$ref": "job-api" } } } ] }