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": "in cillum", "options": { "description": "Example job description", "type": "automation", "groups": [ "7423b16910ffbbb15963559c", "2ae673006e7beaee15f1e74e" ] } }
{ "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 retrieved search results", "data": { "_id": "c2ef78e2c5867f239eb087ce", "font_size": 55582259, "type": "resource:action", "created": "2013-02-02T22:04:40.047Z", "last_updated": "2016-05-24T22:44:18.073Z", "createdVersion": "659907.0.705", "lastUpdatedVersion": "15.5802013.9140", "canvasVersion": 3, "encodingVersion": 1, "migrationVersion": -30740301, "name": "myCoolDocumentName", "description": null, "preAutomationTime": 79362876.1904155, "sla": -87172758.62433627, "decorators": [ { "type": "encryption", "pointer": "/~0/q1mCPi/u4/E9E/~1/SO,qS/~1/~1/l/NB9vsv01c4" }, { "type": "encryption", "pointer": "/~1" }, { "type": "encryption", "pointer": "/qho6/BWrF/~1/fybV1wOSa" }, { "type": "encryption", "pointer": "/~1/~0/~1/~1" }, { "type": "encryption", "pointer": "/~0/~1/~1/~1/Rc52-e/~0/FXbuvUk9" } ], "status": "paused", "tags": [], "error": [ { "task": "job", "message": "Job has no available transitions. c841 could have led to the workflow end task, but did not. These tasks performed in a way that the end of the workflow could not be reached.", "timestamp": 1627323002574 }, { "task": "job", "message": "Job has no available transitions. c841 could have led to the workflow end task, but did not. These tasks performed in a way that the end of the workflow could not be reached.", "timestamp": 1627323002574 } ], "warnings": [ { "task": "error_handler", "name": "myCoolDocumentName" }, { "task": "3a1f", "name": "myCoolDocumentName", "message": "sunt veniam reprehenderit irure dolore" }, { "task": "workflow_end", "name": "myCoolDocumentName" }, { "task": "error_handler", "name": "myCoolDocumentName" } ], "ancestors": null, "validationErrors": [ { "keyword": "id", "dataPath": "Ut sed", "schemaPath": "Ut", "message": "non aliqua irure Lorem" }, { "keyword": "exercitation quis tempor esse", "dataPath": "minim voluptate id cupidatat", "schemaPath": "officia esse", "message": "quis laboris ea nisi" }, { "keyword": "ut Excepteur in", "dataPath": "do culpa nisi ea", "schemaPath": "dolore", "message": "dolor commodo" }, { "keyword": "non", "dataPath": "Lorem laborum", "schemaPath": "consectetur", "message": "incididunt tempor id" } ], "created_by": null, "last_updated_by": { "_id": "2af6291391d5d45dbe9d1874", "provenance": "elit reprehenderit occaecat pariatur sit", "username": "in velit proident dolore", "firstname": "aliqua in occaecat sint Lorem", "memberOf": [ { "groupId": "acc8e3fcbc5b9764d205284b", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "ex tempor dolor officia" }, { "roleId": "enim cupidatat" } ], "inactive": true, "lastLogin": "1967-03-26T19:25:15.113Z", "_meta": { "created": "1952-11-11T11:34:12.216Z", "updated": "1963-01-15T16:47:04.537Z", "migrationVersion": 42961230 }, "email": "cupidatat in occaecat" }, "tasks": { "19": { "actor": "job", "groups": [ "44b16a7a3afd17893d701da0" ], "iterations": [ "230Dd5d0-c2bA-Ee74-4136-9a213Ad14C2C", "9dDD3AF9-EAAF-9793-FDeA-D6eAbDd36Fe7" ], "x": -77740052.28140824, "y": 50988901.60224903, "gridCoordinate": { "x": 52457507.122428566, "y": 52080008.79091698 }, "name": "culpa anim eu", "location": "Application", "locationType": null, "app": "Ut adipisicing anim proident", "canvasName": "veniam", "displayName": "eu sunt", "summary": "est", "description": "eiusmod irure deserunt aliqua", "variables": { "error": "", "decorators": [ { "type": "encryption", "pointer": "/~0/~0/Fabh5a/~0/zg,/vh.hzor/nY7msp3" }, { "type": "encryption", "pointer": "/tLe7j" } ] }, "deprecated": true, "scheduled": true, "matched": [ { "key": "ea eiusmod velit", "highlightString": "velit aliquip" }, { "key": "aliqua adipisicing fugiat id eiusmod", "highlightString": "velit pariatur eiusmod proident" }, { "key": "incididunt in exercitation sed", "highlightString": "pariatur ea voluptate tempor" } ], "status": "incomplete", "previous": { "incomplete": [ "workflow_start", "error_handler", "e28f", "workflow_start", "e28f" ], "complete": [ "e28f", "3a1f", "3a1f", "e28f" ], "error": [ "error_handler", "3a1f", "error_handler" ] }, "taskId": "workflow_start", "transitions": { "success": [ { "task": "workflow_start", "type": "revert" }, { "task": "e28f", "type": "revert" }, { "task": "workflow_end", "type": "standard" }, { "task": "error_handler", "type": "revert" }, { "task": "workflow_start", "type": "standard" } ], "failure": [ { "task": "workflow_start", "type": "revert" }, { "task": "e28f", "type": "loop" }, { "task": "error_handler", "type": "revert" }, { "task": "workflow_end", "type": "loop" }, { "task": "error_handler", "type": "revert" } ], "error": [ { "task": "3a1f", "type": "revert" }, { "task": "workflow_end", "type": "loop" }, { "task": "3a1f", "type": "loop" }, { "task": "workflow_end", "type": "standard" } ] }, "serverId": "sed dolor", "start_time": "1988-02-12T07:50:13.73Z", "end_time": 21553035.065578595, "finish_state": "failure", "retrySettings": null, "type": "automatic" }, "workflow_start": { "x": 33835231.231562406, "y": 79820871.76094392, "gridCoordinate": { "x": 77438578.44123408, "y": 55100429.65762892 }, "name": "workflow_start", "summary": "workflow_start", "taskId": "workflow_start", "metrics": { "start_time": -14331918.553385273, "finish_state": "failure", "user": "Pronghorn" }, "groups": [ { "_id": "09c4a3158c2b66c2e9fcd6e0", "provenance": "elit", "name": "dolor", "description": "occaecat tempor magna laborum", "memberOf": [ { "groupId": "8d23f49d1ce2dea2cce8abef", "aaaManaged": true }, { "groupId": "a5d9143fccb2dab0d937287f", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "non incididunt ut et exercitation" }, { "roleId": "eu dolor ea irure" }, { "roleId": "aliquip in" }, { "roleId": "pariatur in eiusmod in" }, { "roleId": "culpa cillum amet" } ], "inactive": false, "_meta": { "created": "2014-06-22T11:54:06.196Z", "updated": "1985-04-10T20:04:59.36Z", "migrationVersion": 92455825 } }, { "_id": "5c61dcc2a52dc2a200ad8c54", "provenance": "eiusmod in", "name": "in incididunt proident", "description": "et minim in est", "memberOf": [ { "groupId": "6706e92ac4b98d52b0da9ad9", "aaaManaged": true }, { "groupId": "50ae67378c7a353d1009be69", "aaaManaged": true }, { "groupId": "420577be8df5a631e5891567", "aaaManaged": false }, { "groupId": "04c9d5bd8ef01db7cf3d53fe", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "ullamco ea consectetur incididunt" }, { "roleId": "dolor anim ea minim" } ], "inactive": true, "_meta": { "created": "2016-12-07T09:00:10.63Z", "updated": "2016-09-12T01:21:22.303Z", "migrationVersion": -14319076 } }, "8284cb0a8e6ca33fbc420a18" ], "iterations": [ "f41aacEA-8CeB-2857-8866-d45fD3D6a2Ea" ] }, "workflow_end": { "x": 36783301.455242425, "y": 8537228.229550436, "gridCoordinate": { "x": -18543597.992726162, "y": 96715739.52431488 }, "name": "workflow_end", "summary": "workflow_end", "taskId": "workflow_end", "endTasks": { "incomplete": [ "e28f", "workflow_end", "error_handler", "3a1f", "workflow_start" ], "complete": [ "workflow_start", "e28f" ], "error": [ "3a1f" ] }, "metrics": { "end_time": -36786585.87934196, "run_time": -96965530.3545955 }, "groups": [ "default" ], "iterations": [] }, "error_handler": { "x": 68557935.21884498, "y": 74624891.15217292, "gridCoordinate": { "x": 95069130.29245457, "y": 34968171.0950343 }, "name": "childJob", "location": "Application", "locationType": "in sunt", "app": "labore eu pariatur", "canvasName": "mollit dolore culpa do", "displayName": "ullamco aliqua in officia", "summary": "voluptate enim", "description": "nostrud in", "variables": { "error": "", "decorators": [ { "type": "encryption", "pointer": "/uPc0r8/d6Z4ZonW/mK,J6V+C/ia/~1/C/T0o4/XfgtQy" } ] }, "deprecated": false, "scheduled": true, "matched": [ { "key": "ut amet", "highlightString": "laboris et amet pariatur" } ], "status": "paused", "previous": { "incomplete": [ "3a1f", "3a1f", "e28f" ], "complete": [ "e28f", "e28f" ], "error": [ "3a1f", "workflow_start" ] }, "taskId": "workflow_end", "transitions": { "success": [ { "task": "workflow_start", "type": "standard" } ], "failure": [ { "task": "error_handler", "type": "loop" }, { "task": "workflow_start", "type": "standard" } ], "error": [ { "task": "workflow_start", "type": "revert" }, { "task": "workflow_start", "type": "loop" }, { "task": "error_handler", "type": "standard" } ] }, "serverId": "ipsum non proident", "start_time": "1979-03-29T09:36:47.926Z", "end_time": 92443066.92142853, "finish_state": "error", "retrySettings": null, "type": "operation", "actor": "job", "groups": [ "02c029b2309668c0bdd71d02", { "_id": "51a2ab90527ce820aeff9cbe", "provenance": "irure veniam et reprehenderit Excepteur", "name": "ad consectetur sunt ut nulla", "description": "sed enim anim amet", "memberOf": [ { "groupId": "7d2118554308541ce3d32eae", "aaaManaged": false }, { "groupId": "c6308c1d039250e9a37cdd52", "aaaManaged": true }, { "groupId": "3ab16c80c5b787e6f48ebf5f", "aaaManaged": false }, { "groupId": "a67f8934a7231370b720adc0", "aaaManaged": false }, { "groupId": "5b0d5c7e2a0cd68f79bb43a2", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "est commodo id" }, { "roleId": "cillum" } ], "inactive": true, "_meta": { "created": "2000-04-09T21:52:22.093Z", "updated": "1948-04-25T06:14:23.206Z", "migrationVersion": 39582803 } } ], "iterations": [ "a59E2cb7-c0e2-Ac0D-EE4c-8B7ECa505b34", "6dAc0cF4-Be2f-933b-bF8b-F9DdDcE6affD" ] } }, "parent": { "task": "consequat", "iteration": -96278204.32146095, "element": -6092385.680811584 }, "errorHandler": null, "groups": [ { "_id": "5d8ed137638621e564909267", "provenance": "proident amet consequat", "name": "dolor Duis consectetur occaecat", "description": "culpa cillum", "memberOf": [ { "groupId": "cda52b80c0175beb23860a86", "aaaManaged": false }, { "groupId": "7ae7734c06fb380a0acb742e", "aaaManaged": true }, { "groupId": "4a09eafb88f3e280cc452f76", "aaaManaged": true }, { "groupId": "ed865ca7073a490b613336b9", "aaaManaged": true }, { "groupId": "6c73c7d8efbf0809c397a8f4", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "enim aliqua eiusmod" }, { "roleId": "culpa Lorem sed" }, { "roleId": "sit irure Duis labore dolore" }, { "roleId": "culpa dolor deserunt sed consectetur" }, { "roleId": "exercitation aliqua eu cupidatat cillum" } ], "inactive": true, "_meta": { "created": "2002-12-10T02:20:04.77Z", "updated": "1952-09-16T14:52:09.025Z", "migrationVersion": 7974772 } }, "default" ], "watchers": [ "0cc8c7534ad9f96a0900a402", "e1e0d67ee34d341e9fca6761", "621071df9274935839e04ddc" ], "metrics": { "start_time": -74565246.92321968, "progress": 0.4863399774753745, "end_time": -37081335.80815147, "user": "d0736825d09bad7fcd424158", "owner": { "_id": "c492ce67b9d2cb740b33bba4", "provenance": "aute quis elit adipisicing sint", "username": "proident exercitation fugiat adipisicing qui", "firstname": "culpa amet ea aliqua", "memberOf": [ { "groupId": "3d24af4945f646aac8e848f0", "aaaManaged": true }, { "groupId": "c0b43259a01b64384ef4cdec", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "Excepteur" } ], "inactive": true, "lastLogin": "1965-07-19T17:24:21.247Z", "_meta": { "created": "2001-05-22T19:15:30.25Z", "updated": "1975-02-12T02:07:15.285Z", "migrationVersion": -48311837 }, "email": "nisi enim culpa sed" } } } }
{ "title": "job", "allOf": [ { "$ref": "common-api#/definitions/success-response" }, { "type": "object", "properties": { "data": { "$ref": "job-api" } } } ] }