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": "et in sed aliquip Lorem", "options": { "description": "Example job description", "type": "automation", "groups": [ "41c18ab49fde2c34702a611f", "cc322fe20efeaba1724e2981" ] } }
{ "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 created the requested item", "data": { "_id": "e355127631222d84429e1c77", "font_size": -46432835, "type": "resource:action", "created": "2023-01-19T00:06:33.93Z", "last_updated": "1971-03-22T19:32:19.187Z", "createdVersion": "33419.14076.766683561", "lastUpdatedVersion": "10.13380.62189-6395.446454.45819090633", "canvasVersion": 3, "encodingVersion": 1, "migrationVersion": 16398849, "name": "myCoolDocumentName", "description": "Some helpful information about the document", "preAutomationTime": -14545119.520137638, "sla": 74121846.12574181, "decorators": [ { "type": "encryption", "pointer": "/~1/~1/Il5xxEbbk/~1/P/r/n/tzy/~0/~1/~0" }, { "type": "encryption", "pointer": "/~0/~0/u/~1/~1/t5n/ZUX8mqIifn/~0/~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 }, { "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": "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 }, { "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": "workflow_end", "name": "myCoolDocumentName", "message": "elit in" }, { "task": "e28f", "name": "myCoolDocumentName" }, { "task": "workflow_end", "name": "myCoolDocumentName" } ], "ancestors": [ "4d72e065ff8d1ff574dcf5bf", "7799aee59210e2ba243bd01a", "dfe0c1cccf286a3bfbf9e2e4" ], "validationErrors": [ { "keyword": "non voluptate", "dataPath": "voluptate", "schemaPath": "nisi", "message": "velit ipsum" }, { "keyword": "ea eu sunt esse", "dataPath": "nisi labore", "schemaPath": "amet sunt ad culpa irure", "message": "Ut minim irure" } ], "created_by": "Pronghorn", "last_updated_by": "3de3a281cdf0175c9d68bec9", "tasks": { "workflow_start": { "x": 8131090.354353085, "y": -108350.35797524452, "gridCoordinate": { "x": -1874697.6452948004, "y": 21303835.740200892 }, "name": "workflow_start", "summary": "workflow_start", "taskId": "workflow_start", "metrics": { "start_time": -26845960.993481383, "finish_state": "failure", "user": "Pronghorn" }, "groups": [ "a3307100d9412930a1e60c52", { "_id": "20b0a29682ef346ec1139786", "provenance": "ea dolore quis", "name": "cillum", "description": "exercitation in", "memberOf": [ { "groupId": "10a315ebc34600da9f781e6e", "aaaManaged": true }, { "groupId": "dd8f7dda2e6c8084f04a5628", "aaaManaged": false }, { "groupId": "80c443ea3129342b37d32a14", "aaaManaged": false }, { "groupId": "332e45f7c96254daebeafb96", "aaaManaged": true }, { "groupId": "89d702937341bded2917bbef", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "sed eu ex irure qui" }, { "roleId": "magna ea" }, { "roleId": "Duis" }, { "roleId": "cillum et Lorem proident" }, { "roleId": "ipsum" } ], "inactive": true, "_meta": { "created": "2021-08-03T17:31:54.124Z", "updated": "1967-07-12T12:15:53.332Z", "migrationVersion": -78948106 } } ], "iterations": [ "8b6104Bd-d9c0-87f0-f15f-dE8F5aC5DdD4" ] }, "workflow_end": { "x": 77844.70006532967, "y": 93288497.046797, "gridCoordinate": { "x": 20548653.4132068, "y": -7155329.936864644 }, "name": "workflow_end", "summary": "workflow_end", "taskId": "workflow_end", "endTasks": { "incomplete": [ "error_handler", "workflow_start", "3a1f", "3a1f", "workflow_start" ], "complete": [ "3a1f", "3a1f", "workflow_start", "3a1f", "workflow_start" ], "error": [ "3a1f", "e28f", "error_handler", "workflow_end", "e28f" ] }, "metrics": { "end_time": 66616130.38870886, "run_time": -48342429.39992634 }, "groups": [ "default", "4c49c364ab2307d9d1bc93d1" ], "iterations": [ "DBEfA0cB-a880-bdaA-AFcD-D33e48eCED2d", "0F3ECfB0-2eEa-9421-A2F4-08e345AeBfA8" ] }, "error_handler": { "x": -64152986.77504913, "y": 43176186.64873657, "gridCoordinate": { "x": 58673033.367349565, "y": 84039055.39805639 }, "name": "childJob", "location": "Application", "locationType": "proident pariatur esse", "app": "voluptate est eiusmod aliqua non", "canvasName": "elit", "displayName": "nostrud Duis", "summary": "ipsum laborum aute in", "description": "exercitation", "variables": { "error": "", "decorators": [ { "type": "encryption", "pointer": "/g00GbPjnVU" } ] }, "deprecated": false, "scheduled": false, "matched": [ { "key": "eu dolor est voluptate velit", "highlightString": "laboris dolor labore sit" } ], "status": "canceled", "previous": { "incomplete": [ "3a1f", "e28f", "workflow_end", "workflow_start" ], "complete": [ "workflow_end" ], "error": [ "e28f", "error_handler", "e28f", "error_handler", "workflow_end" ] }, "taskId": "workflow_end", "transitions": { "success": [ { "task": "workflow_end", "type": "loop" }, { "task": "e28f", "type": "standard" }, { "task": "workflow_start", "type": "loop" }, { "task": "error_handler", "type": "revert" }, { "task": "workflow_end", "type": "standard" } ], "failure": [ { "task": "workflow_end", "type": "loop" }, { "task": "workflow_start", "type": "standard" }, { "task": "error_handler", "type": "revert" } ], "error": [ { "task": "workflow_end", "type": "revert" }, { "task": "3a1f", "type": "standard" }, { "task": "e28f", "type": "loop" }, { "task": "error_handler", "type": "loop" }, { "task": "workflow_start", "type": "standard" } ] }, "serverId": "proident veniam", "start_time": "1996-04-24T07:23:13.044Z", "end_time": -50389999.945592925, "finish_state": "success", "retrySettings": { "state": [ "success", "error", "success" ], "autoRetry": true, "limit": 75100403, "delay": 80636285, "count": 70552619, "finishedRetrying": true }, "type": "operation", "actor": "job", "groups": [ { "_id": "5fd10cf1fc33fbbcf553c451", "provenance": "sed id", "name": "commodo proident culpa", "description": "incididunt", "memberOf": [ { "groupId": "80472c05e4328312d3cc834a", "aaaManaged": true }, { "groupId": "8db9803f560347cb84be7b09", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "amet" }, { "roleId": "sunt ea nisi" }, { "roleId": "non consequat ex proident laboris" } ], "inactive": false, "_meta": { "created": "2005-10-22T15:32:23.729Z", "updated": "1982-09-21T13:29:43.492Z", "migrationVersion": 95079147 } }, "01d2484e2a78339fa5fee113", { "_id": "3e6e7b37bc5da7cd6cdc3334", "provenance": "Ut amet incididunt", "name": "officia consectetur deserunt elit", "description": "dolor ad Ut esse aute", "memberOf": [ { "groupId": "6e6e0884d4b99492521d70ec", "aaaManaged": true }, { "groupId": "e0def8659ad455caa5bd51d5", "aaaManaged": false }, { "groupId": "2943112bc86b1dc9b1280169", "aaaManaged": false }, { "groupId": "7ee2d6f7950263827a468736", "aaaManaged": false }, { "groupId": "0ff415ae4e1070ba3ac9e082", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "pariatur do" }, { "roleId": "ipsum elit ad sunt in" }, { "roleId": "voluptate irure aliquip occaecat" } ], "inactive": false, "_meta": { "created": "2000-11-01T19:31:41.083Z", "updated": "1964-03-12T12:13:05.449Z", "migrationVersion": -25127469 } }, "6cb2121b2d90e3eac5c8aa70", { "_id": "2b595cd65da7604c12779cac", "provenance": "culpa", "name": "qui deserunt fugiat anim consectetur", "description": "consequat eiusmod ut velit et", "memberOf": [ { "groupId": "5c8f2a7e8639c552fec6f018", "aaaManaged": true }, { "groupId": "834cb9e4cca93b53a0dce56b", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "in pariatur Ut" }, { "roleId": "dolore" }, { "roleId": "voluptate ullamco" }, { "roleId": "incididunt ullamco est occaecat" } ], "inactive": false, "_meta": { "created": "1957-04-26T15:49:09.415Z", "updated": "2001-06-05T07:46:37.55Z", "migrationVersion": -38882441 } } ], "iterations": [ "F4035df4-8F45-bc74-FbEB-6aef55Ba2FAe", "3e464DF8-2F64-bE60-5AAe-F4A4a9fcBfb1" ] }, "2eb": { "actor": { "_id": "67d0340301758b5fe10b9db7", "provenance": "deserunt cillum pariatur aliquip", "username": "dolor officia", "firstname": "do non in dolore Duis", "memberOf": [ { "groupId": "c9a89dcdd2cd7a6e5c988020", "aaaManaged": false }, { "groupId": "6df7fa60fbebc010582faa92", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "do id in officia nostrud" } ], "inactive": false, "lastLogin": "2023-12-06T10:24:06.783Z", "_meta": { "created": "1979-12-09T08:15:01.17Z", "updated": "1993-05-13T15:34:36.477Z", "migrationVersion": -28707233 }, "email": "ut" }, "groups": [ "e4da2dbf8d06a4b6cbc1a45f", { "_id": "45eacb3f18e2118998f9b6c5", "provenance": "ullamco ut", "name": "do", "description": "cupidatat proident esse", "memberOf": [ { "groupId": "a6bfbb34d4d140c1d4b1aa95", "aaaManaged": true }, { "groupId": "b7039608ccfa2a645dc5283f", "aaaManaged": true }, { "groupId": "2277e7fd7eb2f0dcd182b71d", "aaaManaged": true }, { "groupId": "1de60ed2fee00ce520b1b6d3", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "voluptate labore" }, { "roleId": "ut do veniam" } ], "inactive": true, "_meta": { "created": "1984-08-19T05:53:45.071Z", "updated": "1978-11-06T12:32:38.997Z", "migrationVersion": 63303740 } } ], "iterations": [ "cc18DbAc-FBbD-eaab-b545-EB1B98cc2c52" ], "x": 2699603.8139009327, "y": -74569410.82969344, "gridCoordinate": { "x": -87326145.39805739, "y": 95428851.04246825 }, "name": "et culpa esse reprehenderit", "location": "Broker", "locationType": null, "app": "aute exercitation adipisicing sint", "canvasName": "childJob", "displayName": "amet minim culpa nisi", "summary": "mollit", "description": "ea ad Lorem dolore", "variables": { "error": "", "decorators": [ { "type": "encryption", "pointer": "/~1/~1/~0/~0/~1" }, { "type": "encryption", "pointer": "/qjdVHcG1WYN/m/4R6/AfDH/Z50+A/t/jRw/ZD3xgTuDsQ9/~0/~1" } ] }, "deprecated": false, "scheduled": false, "matched": [ { "key": "ullamco officia", "highlightString": "aliqua irure" }, { "key": "enim", "highlightString": "nisi in Ut eu deserunt" }, { "key": "occaecat eiusmod", "highlightString": "do ullamco consequat dolore" }, { "key": "qui occaecat aliqua", "highlightString": "aliqua adipisicing quis nostrud Duis" } ], "status": "running", "previous": { "incomplete": [ "workflow_start", "workflow_start", "error_handler", "workflow_end" ], "complete": [ "workflow_start", "3a1f", "e28f", "workflow_start", "3a1f" ], "error": [ "error_handler", "workflow_start", "workflow_end" ] }, "taskId": "workflow_start", "transitions": { "success": [ { "task": "error_handler", "type": "revert" }, { "task": "workflow_start", "type": "loop" } ], "failure": [ { "task": "error_handler", "type": "standard" }, { "task": "e28f", "type": "standard" }, { "task": "error_handler", "type": "loop" }, { "task": "e28f", "type": "revert" } ], "error": [ { "task": "error_handler", "type": "standard" }, { "task": "e28f", "type": "loop" }, { "task": "workflow_start", "type": "loop" }, { "task": "e28f", "type": "loop" }, { "task": "error_handler", "type": "revert" } ] }, "serverId": "id in dolor enim", "start_time": "1958-11-06T01:06:50.19Z", "end_time": -2749273.003754422, "finish_state": "success", "retrySettings": { "state": [ "failure", "failure", "error", "failure", "error" ], "autoRetry": true, "limit": 13202709, "delay": 84024426, "count": 75108684, "finishedRetrying": true }, "loop": { "atLeastOneComplete": false, "finishedCount": -1904253.923762679, "outgoing": [ null ] }, "childJobs": [ { "_id": "dolor irure Ut", "name": "laboris et", "iteration": -39485764.843707114 }, { "_id": "laborum proident elit amet", "name": "adipisicing sit exercitation deserunt", "iteration": -60465694.61501625 }, { "_id": "nostrud anim Excepteur", "name": "ut proident pariatur", "iteration": 29167778.682303697 }, { "_id": "reprehenderit", "name": "magna sint", "iteration": 12679631.536363363 } ] } }, "parent": { "task": "mollit fugiat sit", "iteration": 11439713.303405344, "element": 95001621.5674895 }, "errorHandler": null, "groups": [ "ef135b32f5b47cc120360845" ], "watchers": [ "04c4fd0e6e3bfe9e124aa6bf", "Pronghorn", null ], "metrics": { "start_time": 49397201.48051703, "progress": 0.7231800744928849, "end_time": 55390231.4948726, "user": "7fc0f09ef3705cdc9ebb84d5", "owner": { "_id": "df6745d198eb52bb86026b4b", "provenance": "aute commodo", "username": "reprehenderit eiusmod nulla", "firstname": "dolor consectetur", "memberOf": [ { "groupId": "99ffa4b2509662244074a901", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "ut consequat aliqua elit" } ], "inactive": false, "lastLogin": "1964-12-23T10:38:41.14Z", "_meta": { "created": "1961-05-09T22:22:15.845Z", "updated": "2005-04-18T19:14:25.801Z", "migrationVersion": 5944129 }, "email": "dolore sunt tempor" } } } }
{ "title": "job", "allOf": [ { "$ref": "common-api#/definitions/success-response" }, { "type": "object", "properties": { "data": { "$ref": "job-api" } } } ] }