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": "sunt", "options": { "description": "Example job description", "type": "automation", "groups": [ "895b71a1d10414df308dbaab", "aad87c0d62d2ae4d002cb344", "543b2a652b589d468ba9b715", "880198c869bae39a9447858c", "482a64f7426b92c7f3428694" ] } }
{ "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": "23e0631d8a93238030362a34", "font_size": 21905647, "type": "resource:action", "created": "1988-04-28T19:36:47.987Z", "last_updated": "1953-08-02T04:20:42.331Z", "createdVersion": "18982.3361.548", "lastUpdatedVersion": "1266783.3293506874.34835-3637.420902.2620.3869929386", "canvasVersion": 1.5, "encodingVersion": 1, "migrationVersion": -82505104, "name": "myCoolDocumentName", "description": null, "preAutomationTime": 78228008.49090865, "sla": 62749226.72545725, "decorators": [ { "type": "encryption", "pointer": "/FcajzfA/RID/EzkR./~0/~1/xp.e2fY" } ], "status": "incomplete", "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 } ], "warnings": [ { "task": "3a1f", "name": "myCoolDocumentName", "message": "cillum in eiusmod Ut" }, { "task": "workflow_start", "name": "myCoolDocumentName", "message": "sed veniam exercitation" }, { "task": "3a1f", "name": "myCoolDocumentName" }, { "task": "error_handler", "name": "myCoolDocumentName" } ], "ancestors": [ "b3773c1e72f76963be9e2376", "52a98d82c3039d136840ebc7" ], "validationErrors": [ { "keyword": "cillum ullamco", "dataPath": "cillum sed dolore mollit laboris", "schemaPath": "quis", "message": "magna Excepteur" }, { "keyword": "in", "dataPath": "non ex do ut in", "schemaPath": "occaecat", "message": "cupidatat" }, { "keyword": "commodo", "dataPath": "ipsum esse enim reprehenderit", "schemaPath": "sunt nulla culpa minim fugiat", "message": "consectetur eu" }, { "keyword": "eiusmod ut cupidatat", "dataPath": "laborum ad eiusmod incididunt consectetur", "schemaPath": "est occaecat dolore Excepteur quis", "message": "laborum" }, { "keyword": "do incididunt tempor ut", "dataPath": "ex Ut adipisicing", "schemaPath": "anim do voluptate", "message": "consectetur id aliquip deserunt esse" } ], "created_by": { "_id": "60eaf40c7b259fdf6a718c70", "provenance": "Ut irure in ullamco nisi", "username": "culpa laborum", "firstname": "Excepteur in", "memberOf": [ { "groupId": "7e15289493cd662bcdbe4b05", "aaaManaged": true }, { "groupId": "cf5fb91be91907ca2253991f", "aaaManaged": true }, { "groupId": "28536347ae4a1e92665805c9", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "id laboris ad non" }, { "roleId": "cillum" }, { "roleId": "Duis" } ], "inactive": false, "lastLogin": "1952-05-09T10:08:51.641Z", "_meta": { "created": "2001-07-23T06:25:45.779Z", "updated": "1967-10-13T11:11:54.022Z", "migrationVersion": -92672804 }, "email": "ut dolore officia anim" }, "last_updated_by": "16a5a5dfa9522085ac437d86", "tasks": { "workflow_start": { "x": 43815393.84662923, "y": 27920712.65160732, "gridCoordinate": { "x": 10678877.738570675, "y": 74143829.96462879 }, "name": "workflow_start", "summary": "workflow_start", "taskId": "workflow_start", "metrics": { "start_time": 64341022.078926355, "finish_state": "success", "user": "8ef460d5ade7aa3665555146" }, "groups": [ "48707847780a1cc568740daa", "default", "default" ], "iterations": [ "df65e14B-713c-Bbc9-fC6c-90b0c8fD8CE3", "dcdaD870-B274-EDcA-c0Ed-ad5eF1CfDea3", "fde7e2C7-d89e-d09a-EAD3-2DABdC9Fb7Dc", "8Edaea7f-87bd-d61b-0579-67bBA47B5F93" ] }, "workflow_end": { "x": 81882614.13980141, "y": 1991521.1985536367, "gridCoordinate": { "x": -11855448.50868401, "y": -76282796.10394579 }, "name": "workflow_end", "summary": "workflow_end", "taskId": "workflow_end", "endTasks": { "incomplete": [ "workflow_end", "e28f", "workflow_start", "error_handler" ], "complete": [ "error_handler", "e28f", "workflow_start", "workflow_start", "error_handler" ], "error": [ "workflow_start", "workflow_start", "3a1f", "workflow_end" ] }, "metrics": { "end_time": -29792532.621312603, "run_time": -31255424.960224465 }, "groups": [ "ea0af07b344123debc9b7c93", "default", "ac10bdf1c28e3601a6d9b979" ], "iterations": [] }, "error_handler": { "x": 18791310.496748894, "y": -98798702.54687533, "gridCoordinate": { "x": -20122009.770018592, "y": -25162010.538589105 }, "name": "childJob", "location": "Adapter", "locationType": "ipsum sit", "app": "et", "canvasName": "culpa pariatur", "displayName": "nulla commodo enim ea dolore", "summary": "in ad id", "description": "quis eu non", "variables": { "error": "", "decorators": [ { "type": "encryption", "pointer": "/L8a,v/~0/~1/z5ml/XtE3E5/~0" } ] }, "deprecated": true, "scheduled": false, "matched": [ { "key": "cupidatat veniam sint dolore", "highlightString": "cupidatat elit ad voluptate" }, { "key": "Lorem", "highlightString": "ut ipsum elit aliquip Excepteur" }, { "key": "proident dolor", "highlightString": "velit Ut veniam" }, { "key": "cupidatat", "highlightString": "id veniam" } ], "status": "paused", "previous": { "incomplete": [ "3a1f", "workflow_end" ], "complete": [ "workflow_end", "workflow_start" ], "error": [ "workflow_start", "workflow_end", "error_handler" ] }, "taskId": "error_handler", "transitions": { "success": [ { "task": "workflow_start", "type": "loop" }, { "task": "workflow_start", "type": "standard" }, { "task": "workflow_start", "type": "loop" }, { "task": "error_handler", "type": "loop" } ], "failure": [ { "task": "3a1f", "type": "standard" }, { "task": "workflow_start", "type": "loop" } ], "error": [ { "task": "3a1f", "type": "loop" }, { "task": "3a1f", "type": "revert" }, { "task": "error_handler", "type": "loop" }, { "task": "e28f", "type": "revert" }, { "task": "workflow_start", "type": "loop" } ] }, "serverId": "nulla deserunt culpa", "start_time": "1948-03-22T00:43:14.22Z", "end_time": 39804108.771034926, "finish_state": "failure", "retrySettings": null, "type": "operation", "actor": "job", "groups": [ "default", { "_id": "72426fe3b52e5e3ec6a3b5b4", "provenance": "tempor reprehenderit ex", "name": "proident irure voluptate", "description": "ipsum laborum", "memberOf": [ { "groupId": "f9e2b3a6126c4854e55b7f7c", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "dolor mollit occaecat" } ], "inactive": true, "_meta": { "created": "1991-11-11T08:45:41.341Z", "updated": "2018-11-06T10:41:03.162Z", "migrationVersion": 9481743 } }, "default" ], "iterations": [ "Ad7bA70e-eeA8-Cb26-1ad9-89d666e6De4a" ] }, "c8d": { "actor": "d9f5d6dbe1be8beabf0e8a3e", "groups": [ { "_id": "ca4a3eb460b73efc9db4a706", "provenance": "enim exercitation", "name": "esse Lorem", "description": "velit do est ea", "memberOf": [ { "groupId": "b7c902e9b81f9d5ab10c539c", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "ea enim dolor" }, { "roleId": "proident veniam Excepteur reprehenderit Duis" }, { "roleId": "Ut Excepteur occaecat commodo eu" } ], "inactive": true, "_meta": { "created": "1987-02-12T22:54:54.128Z", "updated": "1977-06-07T08:29:09.697Z", "migrationVersion": -57112859 } }, "a84432910a63696269c57530", "85e0abb093d1e378ea09c1c5" ], "iterations": [ "9b1B74d9-31bF-B1F8-DA95-B19bFFD3fbfd", "1e78dd6a-30eb-4a6c-E9EE-Cacfba6fBfC7" ], "x": -87937293.33762057, "y": -77456936.4070866, "gridCoordinate": { "x": 52307750.9662855, "y": -94694364.52275853 }, "name": "pending", "summary": "nisi qui aute do", "description": "non esse dolore pariatur" } }, "parent": { "task": "ullamco dolor ad", "iteration": 82833395.45121217, "element": -9852266.50974673 }, "errorHandler": { "actor": "04979ec977437c6cffaa309f", "groups": [ "a83f4e6427121e6495552b6f", "default", "default", "2a89d16b1ee69ff8c5d8222b" ], "iterations": [], "x": -28146802.230208486, "y": -17081110.917304084, "gridCoordinate": { "x": -27641142.041057125, "y": 35966692.55548331 }, "name": "pending", "summary": "dolore ex", "description": "elit aliqua laborum" }, "groups": [ "default", "default", "default" ], "watchers": [ "c79db3fa77b86fa23998c8d3", "Pronghorn", null, null ], "metrics": { "start_time": -48469147.69423267, "progress": 0.4333522979412665, "end_time": 25032350.70895818, "user": null, "owner": "Pronghorn" } } }
{ "title": "job", "allOf": [ { "$ref": "common-api#/definitions/success-response" }, { "type": "object", "properties": { "data": { "$ref": "job-api" } } } ] }