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", "options": { "description": "Example job description", "type": "automation", "groups": [ "6806078518636f1c5360d0f4", "b9c675bc731f9d97f3563c8d", "bd1d0d5698e5c6750f7a81a3" ] } }
{ "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": "1f9adb761eba9a161150231e", "font_size": -54524904, "type": "resource:action", "created": "1988-06-20T07:12:57.974Z", "last_updated": "1947-09-12T00:57:08.977Z", "createdVersion": "1.31245846.5", "lastUpdatedVersion": "27211284511.738.4449", "canvasVersion": 3, "encodingVersion": 1, "migrationVersion": 93800817, "name": "myCoolDocumentName", "description": null, "preAutomationTime": -18181154.347218916, "sla": -31418091.82135047, "decorators": [ { "type": "encryption", "pointer": "/G6czmFNv7pk/LTYv+JH2oo/~1/u/~0/~1/~0/aiXUWt4/VfcXvXt+l/m" }, { "type": "encryption", "pointer": "/~0/~1/eFx-mX-ddxY/~0/dz5mjM+c7y/~0/~0/~1/~1/~0" }, { "type": "encryption", "pointer": "/Fxg/bLWydO/~0/U.AM5p5v4e/~1" } ], "status": "running", "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_start", "name": "myCoolDocumentName" }, { "task": "error_handler", "name": "myCoolDocumentName", "message": "enim" }, { "task": "error_handler", "name": "myCoolDocumentName" } ], "ancestors": null, "validationErrors": [ { "keyword": "aliquip reprehenderit ex consectetur ut", "dataPath": "id aliquip", "schemaPath": "sunt labore", "message": "Lorem magna exercitation" }, { "keyword": "in esse nulla ex", "dataPath": "tempor voluptate pariatur dolor", "schemaPath": "voluptate do", "message": "deserunt eiusmod" } ], "created_by": { "_id": "705ab4d66e2d6d1bb5e718a3", "provenance": "sit in aliqua id non", "username": "occaecat eu quis Excepteur", "firstname": "irure eiusmod esse", "memberOf": [ { "groupId": "428d9a5a266f2a94438cb167", "aaaManaged": false }, { "groupId": "61f08d93921c704a713c8932", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "exercitation amet non" }, { "roleId": "amet pariatur commodo" }, { "roleId": "do" } ], "inactive": false, "lastLogin": "1975-09-15T03:08:08.654Z", "_meta": { "created": "1946-12-10T21:50:32.99Z", "updated": "2016-10-31T21:01:27.246Z", "migrationVersion": 47624525 }, "email": "esse" }, "last_updated_by": "Pronghorn", "tasks": { "workflow_start": { "x": 5173217.243221417, "y": -261450.30899122357, "gridCoordinate": { "x": 15696913.146460906, "y": 56563962.03793776 }, "name": "workflow_start", "summary": "workflow_start", "taskId": "workflow_start", "metrics": { "start_time": -96413040.9102661, "finish_state": "error", "user": "e46956ba1ae5c3bfaaff54c4" }, "groups": [ "default", "c09fc24d39836ce4ba0617ed", "default", { "_id": "20ce25faf9193c8176abdede", "provenance": "magna ut sunt velit", "name": "eiusmod Excepteur", "description": "in mollit nulla", "memberOf": [ { "groupId": "d78ef03a168f2edc66abffda", "aaaManaged": true }, { "groupId": "32e0c491a97d5cecd1854a6c", "aaaManaged": true }, { "groupId": "5ceb43f9dc79a1101ffeb844", "aaaManaged": false }, { "groupId": "51b00cd86373f2b4156f5506", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "sunt ut amet nulla" }, { "roleId": "irure incididunt consequat est ut" } ], "inactive": true, "_meta": { "created": "1998-07-07T09:48:38.753Z", "updated": "1969-10-24T14:04:03.38Z", "migrationVersion": -51617602 } }, "4ea4f56542afdea81dbb32db" ], "iterations": [ "f5cA391d-DAE0-C8fB-9FBe-8BF0a0b03Abb", "d226Cb72-6a9e-DbcB-9E3E-DeFB6B647a4b" ] }, "workflow_end": { "x": 33744435.2995913, "y": -27900948.308955178, "gridCoordinate": { "x": -88517561.93115433, "y": 5795657.936810002 }, "name": "workflow_end", "summary": "workflow_end", "taskId": "workflow_end", "endTasks": { "incomplete": [ "error_handler" ], "complete": [ "workflow_end" ], "error": [ "workflow_end", "workflow_start", "workflow_end" ] }, "metrics": { "end_time": -94840069.75906238, "run_time": 79768201.80018184 }, "groups": [ "e5a89c8dea5652a51202eea5", "7d71ffd4ac8b592b83cbc63b", "21e2a5fcf881ad13d592b323", { "_id": "e0aa76dda5d8c5f2c8cd2f22", "provenance": "elit sit consectetur minim fugiat", "name": "Lorem tempor nostrud", "description": "veniam ea nostrud", "memberOf": [ { "groupId": "cc1d3cba5c1dae6eb67cd714", "aaaManaged": true }, { "groupId": "84d1b85afea457014acd1e5d", "aaaManaged": true }, { "groupId": "8d6dfaac3459589d5a1b8781", "aaaManaged": false }, { "groupId": "12decadc1004a9a3d6e295d9", "aaaManaged": true }, { "groupId": "0d77b2a11132cb84c330eef0", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "minim et consectetur in" } ], "inactive": false, "_meta": { "created": "1984-02-23T01:58:09.355Z", "updated": "1951-03-09T15:19:02.249Z", "migrationVersion": 44845553 } } ], "iterations": [] }, "error_handler": { "x": 16548395.278644621, "y": -39723187.98574626, "gridCoordinate": { "x": -47926299.39334714, "y": 80237382.5113442 }, "name": "childJob", "location": "Application", "locationType": "cupidatat ex", "app": "quis", "canvasName": "fugiat", "displayName": "ipsum ad fugiat", "summary": "reprehenderit", "description": "do sed non commodo quis", "variables": { "error": "", "decorators": [ { "type": "encryption", "pointer": "/AXBr/lh/~0/~1/ZLvAx/Zi8b/locG/~1/~0/~1/F/~1/Zgpr,JQP,jg" }, { "type": "encryption", "pointer": "/~1/TLfP1a-xks" }, { "type": "encryption", "pointer": "/k6AU/~1" } ] }, "deprecated": true, "scheduled": false, "matched": [ { "key": "dolore cillum", "highlightString": "dolore sed laborum dolor veniam" } ], "status": "running", "previous": { "incomplete": [ "workflow_end" ], "complete": [ "workflow_end", "e28f" ], "error": [ "workflow_end", "workflow_end", "workflow_start" ] }, "taskId": "3a1f", "transitions": { "success": [ { "task": "e28f", "type": "revert" }, { "task": "workflow_end", "type": "loop" }, { "task": "workflow_start", "type": "standard" } ], "failure": [ { "task": "error_handler", "type": "standard" }, { "task": "workflow_start", "type": "revert" }, { "task": "workflow_end", "type": "standard" }, { "task": "error_handler", "type": "loop" }, { "task": "workflow_start", "type": "loop" } ], "error": [ { "task": "error_handler", "type": "revert" }, { "task": "error_handler", "type": "loop" }, { "task": "error_handler", "type": "loop" } ] }, "serverId": "aute consequat", "start_time": "1960-08-19T04:29:30.882Z", "end_time": -50567261.745417856, "finish_state": "failure", "retrySettings": null, "type": "operation", "actor": "job", "groups": [ "894df2b0032edcde76247cc0", "77c7dc18bd63e71edacb3cd3", "default" ], "iterations": [ "4a1205FC-aEcd-AafA-6b5E-b9c06E9E365b" ] }, "0a80": { "actor": "Pronghorn", "groups": [ "default", "c58b4334cba43aa1c9fa6a51" ], "iterations": [ "bF2fB0aE-Ac9d-2dCF-A099-dc0c70eC7aeF", "3B695b8B-6209-b1c0-A312-7E46Ce425a03" ], "x": -32598532.70292701, "y": 93105757.8317875, "gridCoordinate": { "x": -15602817.358165756, "y": -97064878.53864472 }, "name": "pending", "summary": "id sunt aliqua", "description": "elit culpa in aliquip" } }, "parent": { "job": "exercitation dolore adipisicing", "task": "enim eiusmod", "iteration": 5165049.141637117, "element": 76263442.95124543 }, "errorHandler": { "actor": null, "groups": [ "default", "2692f6f124219727d298d26c" ], "iterations": [ "fcbcbdc0-f302-8dc3-4aAF-C0e65DfF6C2A", "1EeEb7ca-febA-f38e-C12B-1C4CDA5d07CD" ], "x": -37764752.20357063, "y": 66278516.85115224, "gridCoordinate": { "x": 93920962.02121896, "y": 37580579.71236557 }, "name": "pending", "summary": "fugiat id enim est commodo", "description": "sint et non" }, "groups": [ { "_id": "3be5368eb468b9dba748d9ce", "provenance": "ea esse dolore minim", "name": "in officia ea", "description": "do exercitation quis pariatur ad", "memberOf": [ { "groupId": "fcb699bd422c1c30e20508c0", "aaaManaged": true }, { "groupId": "2a7147fb11ca011e0363ee28", "aaaManaged": true }, { "groupId": "1817ee5b67a5c54ebad9110a", "aaaManaged": true }, { "groupId": "592cbd053416a819988ee963", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "consequat ex dolore fugiat deserunt" } ], "inactive": false, "_meta": { "created": "2024-08-06T00:26:15.449Z", "updated": "1982-04-25T08:41:30.293Z", "migrationVersion": -42323572 } }, { "_id": "3a6880e35c382529e72bf6ab", "provenance": "Ut exercitation aliquip do minim", "name": "laborum occaecat sit Excepteur pariatur", "description": "elit", "memberOf": [ { "groupId": "76ddebddca7abcbcba1492db", "aaaManaged": false }, { "groupId": "0d51e63bc3d51b7f15692698", "aaaManaged": false }, { "groupId": "21009611675029fd0993cbea", "aaaManaged": true }, { "groupId": "ee2d49eb96f1f6bfffa85fca", "aaaManaged": false }, { "groupId": "1121e8f0eb70e5d38c8a51ec", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "consectetur aute quis elit" } ], "inactive": true, "_meta": { "created": "1968-09-19T02:04:19.104Z", "updated": "1990-04-18T23:06:25.113Z", "migrationVersion": 66697528 } }, { "_id": "cd2601e4e82b7606c435e987", "provenance": "Duis", "name": "nostrud ea pariatur", "description": "et proident aute laborum cupidatat", "memberOf": [ { "groupId": "b543bb091ca81c2e2bd89fa4", "aaaManaged": false }, { "groupId": "fdb8b1886520451e65bd6afa", "aaaManaged": true }, { "groupId": "c9d8ad5da029606e7b4925bd", "aaaManaged": true }, { "groupId": "8e9911f2a41aebc54d002ae2", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "dolor aliquip minim" }, { "roleId": "ex dolor nisi cupidatat magna" }, { "roleId": "deserunt sit magna in aliqua" }, { "roleId": "anim ipsum ad commodo sint" } ], "inactive": false, "_meta": { "created": "1969-03-11T07:36:30.146Z", "updated": "1964-12-15T21:47:12.801Z", "migrationVersion": -322866 } } ], "watchers": [ null, null, null, { "_id": "df2fd63f625c344050528892", "provenance": "Excepteur Ut ad", "username": "cillum et reprehenderit", "firstname": "consequat ut", "memberOf": [ { "groupId": "724fba742b716142e5e15fcf", "aaaManaged": false }, { "groupId": "b5fa9a39ca175b7deba51c52", "aaaManaged": false }, { "groupId": "724c18bd25f46045ca4e0be7", "aaaManaged": false }, { "groupId": "d74009ff9e4ee0e26a69f7c2", "aaaManaged": true }, { "groupId": "dc7de948ad1f4e120f21a545", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "non adipisicing exercitation culpa nostrud" }, { "roleId": "est ipsum eiusmod" }, { "roleId": "commodo laboris" }, { "roleId": "dolor in Duis amet" }, { "roleId": "minim veniam" } ], "inactive": true, "lastLogin": "1989-03-29T10:12:50.154Z", "_meta": { "created": "1977-11-23T10:21:08.638Z", "updated": "2007-01-24T14:34:17.489Z", "migrationVersion": -14369564 }, "email": "est et" }, null ], "metrics": { "start_time": -84568650.90564798, "progress": 0.3300486484401426, "end_time": -78574148.1164516, "user": null, "owner": { "_id": "05f275d9b6756b8f1b893a94", "provenance": "in", "username": "ut ex est ipsum", "firstname": "reprehenderit do deserunt voluptate adipisicing", "memberOf": [ { "groupId": "4f69fa6803b0cae50a1ad867", "aaaManaged": true }, { "groupId": "20599dcc79d3be727528d800", "aaaManaged": true }, { "groupId": "9f4f253e0dbb19dcdabd6851", "aaaManaged": false }, { "groupId": "5546c1ea637707e4baa052ea", "aaaManaged": true }, { "groupId": "960c97897bad4f5a8f3b58fd", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "Excepteur Ut id" }, { "roleId": "ad" }, { "roleId": "in ullamco consectetur Lorem deserunt" }, { "roleId": "sunt proident nulla" } ], "inactive": false, "lastLogin": "1999-07-01T00:27:30.105Z", "_meta": { "created": "1983-06-06T02:37:15.416Z", "updated": "2016-06-14T11:50:27.915Z", "migrationVersion": -66529139 }, "email": "quis non labore fugiat" } } } }
{ "title": "job", "allOf": [ { "$ref": "common-api#/definitions/success-response" }, { "type": "object", "properties": { "data": { "$ref": "job-api" } } } ] }