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": "enim exercitation sit", "options": { "description": "Example job description", "type": "automation", "groups": [ "39b9661c4e407786835b5e7f" ] } }
{ "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": "4a042e7232017aab454973a3", "font_size": 16532445, "type": "resource:action", "created": "2018-05-30T21:02:52.419Z", "last_updated": "1996-03-14T05:48:47.893Z", "createdVersion": "291412.8.0", "lastUpdatedVersion": "0.4157796.58233811", "canvasVersion": 1.5, "encodingVersion": 1, "migrationVersion": 20457901, "name": "myCoolDocumentName", "description": "Some helpful information about the document", "preAutomationTime": -17828567.123676732, "sla": -39161189.954671726, "decorators": [ { "type": "encryption", "pointer": "/vM8Dc/rM//~1/~1/mOPgA5TZF/tYZmIbol6/Cve6XrJ/jIEBu/~0/~0/~0" }, { "type": "encryption", "pointer": "/~1/~0/WF/koaVigT/~0/wVcsOWeeCO/~1/~1/AfKaxF/~0" }, { "type": "encryption", "pointer": "/~0/KxiEoTmVeW/~0/~0/r1/P7S,atGc/~0/oJVr6LV/HqE-gzA/YpH++3m/~0" } ], "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 } ], "warnings": [ { "task": "3a1f", "name": "myCoolDocumentName", "message": "in veniam magna amet sunt" }, { "task": "workflow_start", "name": "myCoolDocumentName" }, { "task": "workflow_start", "name": "myCoolDocumentName" }, { "task": "3a1f", "name": "myCoolDocumentName" } ], "ancestors": null, "validationErrors": [ { "keyword": "dolore nulla sed", "dataPath": "pariatur tempor cupidatat amet ut", "schemaPath": "fugiat", "message": "in irure" }, { "keyword": "ex amet aliquip velit magna", "dataPath": "consequat velit dolore qui", "schemaPath": "dolore dolor", "message": "consequat nulla anim cillum" }, { "keyword": "nostrud", "dataPath": "dolor labore quis Lorem", "schemaPath": "Ut velit in sed", "message": "eiusmod laboris" }, { "keyword": "ad minim magna", "dataPath": "do proident quis occaecat", "schemaPath": "irure Lorem cupidatat", "message": "aliqua reprehenderit incididunt eu" }, { "keyword": "consequat velit Lorem laboris Excepteur", "dataPath": "Lorem", "schemaPath": "elit esse aliqua deserunt magna", "message": "do laborum cillum Duis est" } ], "created_by": { "_id": "847b03445ac88a95c9f6f5c8", "provenance": "eu", "username": "Ut elit anim", "firstname": "nostrud veniam", "memberOf": [ { "groupId": "0ca81001d6ee92939778452e", "aaaManaged": false }, { "groupId": "984a430ea3dca7ebef9540a0", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "officia sunt qui" } ], "inactive": true, "lastLogin": "2004-10-29T19:21:41.326Z", "_meta": { "created": "1994-08-20T05:45:40.591Z", "updated": "1974-09-30T14:46:39.762Z", "migrationVersion": -17522143 }, "email": "quis" }, "last_updated_by": "Pronghorn", "tasks": { "workflow_start": { "x": 94323238.72827727, "y": 24277219.761119932, "gridCoordinate": { "x": -84354446.19358297, "y": 8483274.566841453 }, "name": "workflow_start", "summary": "workflow_start", "taskId": "workflow_start", "metrics": { "start_time": 52573736.07855335, "finish_state": "success", "user": null }, "groups": [ "4feb129a923ef7f031551452", "default" ], "iterations": [ "cC83788B-f798-f7d5-Ecf9-56cef6cA0cC7" ] }, "workflow_end": { "x": -78089203.17409113, "y": -37432121.27395541, "gridCoordinate": { "x": 24070095.718390495, "y": -70258724.77572119 }, "name": "workflow_end", "summary": "workflow_end", "taskId": "workflow_end", "endTasks": { "incomplete": [ "workflow_end", "error_handler" ], "complete": [ "3a1f" ], "error": [ "workflow_end", "3a1f", "e28f", "3a1f" ] }, "metrics": { "end_time": 6653893.33743161, "run_time": 27262088.41967517 }, "groups": [ { "_id": "8ba06cd2147d62b35b8fb4b9", "provenance": "aliquip", "name": "deserunt nulla do veniam", "description": "Ut", "memberOf": [ { "groupId": "0131ec40a2dc2df7b0510584", "aaaManaged": false }, { "groupId": "a2490b26c8987992ee50c345", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "ullamco ipsum adipisicing consectetur" }, { "roleId": "deserunt eu amet id" }, { "roleId": "quis" }, { "roleId": "Excepteur" } ], "inactive": true, "_meta": { "created": "2006-04-01T20:30:29.846Z", "updated": "2014-03-22T15:47:07.441Z", "migrationVersion": -73246282 } } ], "iterations": [ "68BB4d1F-7CBA-1a5C-6E2C-a026E9bAad7D", "1C3BF3AB-d588-E21c-e2D6-B7Fecf7da92F", "35fF660D-eAd8-B066-e5bB-7Ded8FFC1a53", "BeCcE0e2-Dd13-1A38-4C8d-CbEaBe27EB5C" ] }, "error_handler": { "x": -27552505.070682094, "y": -44876426.077504486, "gridCoordinate": { "x": -27141608.126307666, "y": 11251704.660943985 }, "name": "childJob", "location": "Broker", "locationType": null, "app": "incididunt dolore commodo aliquip ad", "canvasName": "in minim ut qui", "displayName": "esse est ipsum eiusmod", "summary": "anim laborum adipisicing aliqua laboris", "description": "magna", "variables": { "error": "", "decorators": [ { "type": "encryption", "pointer": "/c1" }, { "type": "encryption", "pointer": "/gq82h,jfRxC/~0/~0/JRQaVl/~1" }, { "type": "encryption", "pointer": "/~0/~0/q9hYA-Di/mut6r0BM/~1" }, { "type": "encryption", "pointer": "/gf--CKYaql/bTSp0D,n/~0" } ] }, "deprecated": true, "scheduled": false, "matched": [ { "key": "officia", "highlightString": "aliquip nulla" }, { "key": "in sed laboris in", "highlightString": "sed reprehenderit irure Excepteur" } ], "status": "error", "previous": { "incomplete": [ "workflow_end", "error_handler", "error_handler", "workflow_end" ], "complete": [ "3a1f", "3a1f", "error_handler", "3a1f" ], "error": [ "3a1f", "workflow_end", "e28f", "3a1f" ] }, "taskId": "e28f", "transitions": { "success": [ { "task": "workflow_start", "type": "standard" }, { "task": "workflow_start", "type": "loop" }, { "task": "workflow_start", "type": "revert" }, { "task": "e28f", "type": "standard" } ], "failure": [ { "task": "error_handler", "type": "loop" } ], "error": [ { "task": "workflow_start", "type": "loop" }, { "task": "3a1f", "type": "standard" }, { "task": "workflow_start", "type": "loop" } ] }, "serverId": "anim est", "start_time": "1997-06-15T03:02:37.204Z", "end_time": 90327204.05792838, "finish_state": "success", "retrySettings": { "state": [ "error", "error", "success" ], "autoRetry": false, "limit": 97254559, "delay": 42108657, "count": 80669176, "finishedRetrying": false }, "type": "operation", "actor": "job", "groups": [ { "_id": "948da3e3d874babac90e18b2", "provenance": "dolore aliquip Lorem sed", "name": "irure", "description": "nisi et", "memberOf": [ { "groupId": "15a7c221476e052c33149185", "aaaManaged": true }, { "groupId": "b448f076b2596802975656ff", "aaaManaged": false }, { "groupId": "178f2e76fbde41f06baf6279", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "occaecat ipsum pariatur" }, { "roleId": "ad nulla" }, { "roleId": "id veniam dolor aliquip" } ], "inactive": true, "_meta": { "created": "1979-05-25T21:05:14.968Z", "updated": "1990-06-07T12:41:23.53Z", "migrationVersion": 57292222 } }, "31c4a5c00b250674a6cfb488", { "_id": "bcc4cff730ddba2c2160c21b", "provenance": "dolore irure", "name": "mollit sed quis deserunt", "description": "ipsum dolore Duis tempor", "memberOf": [ { "groupId": "09d7493e8c997ee8cfa0773e", "aaaManaged": true }, { "groupId": "e995f560a3faef8bb61d9833", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "et ullamco" }, { "roleId": "dolore ullamco" } ], "inactive": false, "_meta": { "created": "1982-06-07T13:33:49.451Z", "updated": "1988-10-14T18:22:38.97Z", "migrationVersion": 77559637 } } ], "iterations": [] }, "e07b": { "actor": "job", "groups": [ "cf96e830a9ce804e5d08f493", "default", "23d902765a06a1d009d5f6eb", "default" ], "iterations": [ "dCb7A9bE-479A-FB93-AC4B-C97Ff02b3d3c", "DaDE749B-66b4-2F5D-fbEa-329bDAF1deAD", "c55fE4d7-14f3-E6Cc-7aA2-2B6dd3D3fEE1" ], "x": -11593918.017728686, "y": -84289642.16308855, "gridCoordinate": { "x": 39422703.74055648, "y": -19129916.42945619 }, "name": "pending", "summary": "in esse ad in ut", "description": "Ut nulla do dolor" } }, "parent": { "task": "adipisicing mollit ipsum Lorem cillum", "iteration": 82641255.59647214, "element": -94627840.42310588 }, "errorHandler": { "actor": "job", "groups": [ "default", { "_id": "298f16d950d71ccf55038016", "provenance": "fugiat commodo nostrud non officia", "name": "in cupidatat ipsum Lorem amet", "description": "velit consectetur tempor", "memberOf": [ { "groupId": "fc92fc6c0b0ef7f711e802a4", "aaaManaged": true }, { "groupId": "ded1e8dbd657c1f1d74d6efb", "aaaManaged": false }, { "groupId": "3994221ba767da7946b703c2", "aaaManaged": false }, { "groupId": "7d479235fbf84af19a78ae74", "aaaManaged": true }, { "groupId": "0bb3cf89c1230b399d4e4d28", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "ut labore et quis" }, { "roleId": "fugiat in eu" }, { "roleId": "voluptate consectetur nulla ea" } ], "inactive": false, "_meta": { "created": "1985-10-15T11:30:11.741Z", "updated": "1957-09-07T22:56:51.916Z", "migrationVersion": 64018865 } } ], "iterations": [ "0242eCCf-CefF-E8Ab-E495-2B7Fd4aB34C0" ], "x": 10097531.4133759, "y": 60669541.76800507, "gridCoordinate": { "x": 70384309.06082776, "y": -7051435.664412424 }, "name": "pending", "summary": "eu deserunt enim", "description": "sint commodo quis in do" }, "groups": [ "d857c6fad05c58d855ec5143", "8082546a59107ffb73974d4b", { "_id": "1628505cfaf90c97d1ef406f", "provenance": "magna ad est", "name": "aliquip ad in adipisicing", "description": "tempor ea", "memberOf": [ { "groupId": "5e082687f02947d90e606788", "aaaManaged": true }, { "groupId": "deb039a44110aaf2d2d9eb7e", "aaaManaged": true }, { "groupId": "ffc32a7ddea470f2f211b8c7", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "anim incididunt adipisicing culpa" } ], "inactive": true, "_meta": { "created": "2013-05-12T18:15:32.206Z", "updated": "2004-11-12T04:17:07.649Z", "migrationVersion": -7097325 } }, "6d27e3f8e653e90272e5a609" ], "watchers": [ "7f7ddbe161f54541531360dc", { "_id": "bbc58ff49277610ed36fbbc0", "provenance": "amet officia", "username": "reprehenderit tempor", "firstname": "est proident", "memberOf": [ { "groupId": "c9079f367ed42273aa0f9fed", "aaaManaged": false }, { "groupId": "b721842c60fffc12807133ab", "aaaManaged": true }, { "groupId": "010a200b61ba90e37360770e", "aaaManaged": true }, { "groupId": "56cd7a73c50d24f10d2bed9c", "aaaManaged": true }, { "groupId": "ee11b3a7fdd1c139cae15cad", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "dolor id ullamco non" } ], "inactive": true, "lastLogin": "2001-09-13T19:42:01.059Z", "_meta": { "created": "1946-06-21T14:33:32.821Z", "updated": "1987-02-11T22:10:07.534Z", "migrationVersion": 76211015 }, "email": "et culpa cupidatat" } ], "metrics": { "start_time": -63241600.1378624, "progress": 0.8412759203048792, "end_time": 99339648.94693336, "user": { "_id": "132abc66098c3ed876215dfd", "provenance": "fugiat sed Duis quis voluptate", "username": "nostrud Lorem id velit", "firstname": "commodo", "memberOf": [ { "groupId": "d34427f7cf10a41026607cb2", "aaaManaged": false }, { "groupId": "3cdef7fb76e414407d23471c", "aaaManaged": false }, { "groupId": "c0324c14f9a52a6fcced3c12", "aaaManaged": true }, { "groupId": "8e490f9c9a43ca5119724185", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "consequat" }, { "roleId": "id" }, { "roleId": "velit nulla" } ], "inactive": true, "lastLogin": "1948-09-06T10:48:40.833Z", "_meta": { "created": "1998-08-19T10:02:03.13Z", "updated": "1997-11-11T11:07:14.914Z", "migrationVersion": 67801185 }, "email": "irure incididunt culpa" }, "owner": null } } }
{ "title": "job", "allOf": [ { "$ref": "common-api#/definitions/success-response" }, { "type": "object", "properties": { "data": { "$ref": "job-api" } } } ] }