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": "sed velit", "options": { "description": "Example job description", "type": "automation", "groups": [ "12b43b187e00e7ff0b4b4334", "23f1ae8ddda1e408c97e3a11" ] } }
{ "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": "d7b216a95f43a8f59adfd32c", "font_size": 92477205, "type": "resource:action", "created": "2015-02-07T16:05:28.367Z", "last_updated": "1952-11-12T03:22:40.828Z", "createdVersion": "1374380017.98623868331.305240631-3904.7909.119", "lastUpdatedVersion": "584227036.634865996.02051840592", "canvasVersion": 1, "encodingVersion": 1, "migrationVersion": 51018252, "name": "myCoolDocumentName", "description": "Some helpful information about the document", "preAutomationTime": -74315997.65588497, "sla": -59331999.82849024, "decorators": [ { "type": "encryption", "pointer": "/RrqKLHaOCM" }, { "type": "encryption", "pointer": "/~1/ngu/~0/~1/~1/~0/ihaWWb/~0/UM+-e9Q,,/~1" }, { "type": "encryption", "pointer": "/~1" }, { "type": "encryption", "pointer": "/w,aJ/IwFx" }, { "type": "encryption", "pointer": "/g/~0/~1/~1/~0/oMe5-rfyaT/~0/W/~0/cDm4" } ], "status": "canceled", "tags": [], "error": [ { "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": "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": "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": "3a1f", "name": "myCoolDocumentName", "message": "nostrud fugiat nulla" }, { "task": "workflow_start", "name": "myCoolDocumentName" } ], "ancestors": null, "validationErrors": [ { "keyword": "occaecat", "dataPath": "Ut officia veniam sed", "schemaPath": "adipisicing", "message": "aute nulla magna" }, { "keyword": "ut laboris ut", "dataPath": "officia", "schemaPath": "Excepteur nostrud", "message": "aliqua aliquip ex" }, { "keyword": "sed officia", "dataPath": "eiusmod", "schemaPath": "officia dolore", "message": "Duis non eiusmod" }, { "keyword": "magna Excepteur", "dataPath": "quis non deserunt", "schemaPath": "deserunt cillum aliqua dolor sunt", "message": "anim" }, { "keyword": "eiusmod aute dolor enim", "dataPath": "pariatur tempor", "schemaPath": "amet sed enim culpa Excepteur", "message": "est mollit fugiat" } ], "created_by": { "_id": "c1e77ebcc3cff55f81674562", "provenance": "aliquip Excepteur nulla", "username": "amet", "firstname": "non", "memberOf": [ { "groupId": "3254a2a539a3475ad219472c", "aaaManaged": false }, { "groupId": "913d27851333ae9854fa271a", "aaaManaged": false }, { "groupId": "5aa7f1c45c5e42b36d3aad6a", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "aliqua id" }, { "roleId": "commodo labore esse Excepteur" }, { "roleId": "ut" }, { "roleId": "velit sunt aliqua consequat" }, { "roleId": "aute" } ], "inactive": true, "lastLogin": "1971-05-27T05:42:34.205Z", "_meta": { "created": "1953-12-15T05:15:32.917Z", "updated": "1967-12-11T04:47:10.437Z", "migrationVersion": 1573798 }, "email": "esse fugiat" }, "last_updated_by": "4d5a70a8bdb50b0d44cb3450", "tasks": { "workflow_start": { "x": 54099965.32735595, "y": -2933045.715194106, "gridCoordinate": { "x": -67347132.66424923, "y": -73051405.91765226 }, "name": "workflow_start", "summary": "workflow_start", "taskId": "workflow_start", "metrics": { "start_time": -28023978.157914937, "finish_state": "failure", "user": null }, "groups": [ "aa27efea08f9837a50b54991", "b87684dec87dc71ff49df258", { "_id": "8c68194e1c4a0ad72d89d263", "provenance": "ea esse tempor consequat Ut", "name": "Ut enim", "description": "in", "memberOf": [ { "groupId": "c75d1b1ee4dddd0bdc7daf06", "aaaManaged": false }, { "groupId": "3be4631baea8a0554c19da03", "aaaManaged": true }, { "groupId": "87a24096a648025d8531182b", "aaaManaged": true }, { "groupId": "9f4fea5696bc3248fbaf1e0b", "aaaManaged": false }, { "groupId": "c366522cf3f7cfa7dcfab9b9", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "sit adipisicing laboris" } ], "inactive": true, "_meta": { "created": "1947-11-23T16:38:35.393Z", "updated": "2000-08-01T15:29:07.564Z", "migrationVersion": 31409073 } }, { "_id": "1a4e39bb714fd083be096b27", "provenance": "ad non commodo laboris consectetur", "name": "nostrud est dolore aute nisi", "description": "officia Lorem dolor", "memberOf": [ { "groupId": "3bb03ea990132c416213bcfa", "aaaManaged": true }, { "groupId": "928c3f0026a908494d5822d8", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "aute in sit commodo" }, { "roleId": "aute ut aliqua dolor" }, { "roleId": "pariatur irure" }, { "roleId": "adipisicing irure" }, { "roleId": "do in quis" } ], "inactive": false, "_meta": { "created": "1979-01-03T21:45:05.041Z", "updated": "1957-10-04T00:18:33.542Z", "migrationVersion": 29802654 } } ], "iterations": [ "8DeAAAcD-7084-6F0b-bf03-bc052Ae3DD4d" ] }, "workflow_end": { "x": -74990432.1308951, "y": -29583137.27202855, "gridCoordinate": { "x": 5073818.539634749, "y": 84981230.79598284 }, "name": "workflow_end", "summary": "workflow_end", "taskId": "workflow_end", "endTasks": { "incomplete": [ "workflow_start", "error_handler", "workflow_start" ], "complete": [ "error_handler", "e28f", "workflow_start" ], "error": [ "3a1f" ] }, "metrics": { "end_time": -23405393.279001758, "run_time": 91882258.142645 }, "groups": [ "default", "abdf2fc5e24b170e05406c6a" ], "iterations": [ "25906C9E-A4EA-D6f7-4e5E-0ba262dfbaE8" ] }, "error_handler": { "x": -58734264.81560622, "y": -68907897.8872081, "gridCoordinate": { "x": 21539848.616808265, "y": -17759163.766215786 }, "name": "childJob", "location": "Broker", "locationType": null, "app": "veniam dolor velit", "canvasName": "veniam sint non tempor", "displayName": "in incididunt sit", "summary": "id Lorem et est qui", "description": "sunt cupidatat quis nulla", "variables": { "error": "", "decorators": [ { "type": "encryption", "pointer": "/ic/h-ksVugXRE/jYb6/~0/UlD0ro7" }, { "type": "encryption", "pointer": "/qzwPKvfe/ZtYy5I.h/~0/zvgwcV.yA3U/q+" } ] }, "deprecated": false, "scheduled": true, "matched": [ { "key": "velit", "highlightString": "anim" }, { "key": "irure Lorem velit dolor", "highlightString": "aliqua velit aliquip occaecat ipsum" }, { "key": "deserunt aute quis", "highlightString": "do magna Lorem commodo adipisicing" }, { "key": "deserunt", "highlightString": "dolor" }, { "key": "sit sint deserunt laboris et", "highlightString": "cillum commodo occaecat est" } ], "status": "failure", "previous": { "incomplete": [ "error_handler", "error_handler", "3a1f" ], "complete": [ "error_handler", "e28f", "3a1f" ], "error": [ "error_handler" ] }, "taskId": "workflow_start", "transitions": { "success": [ { "task": "workflow_start", "type": "loop" }, { "task": "e28f", "type": "revert" }, { "task": "3a1f", "type": "standard" }, { "task": "e28f", "type": "loop" }, { "task": "e28f", "type": "standard" } ], "failure": [ { "task": "e28f", "type": "standard" }, { "task": "error_handler", "type": "loop" }, { "task": "3a1f", "type": "revert" } ], "error": [ { "task": "workflow_start", "type": "loop" }, { "task": "workflow_start", "type": "standard" } ] }, "serverId": "do", "start_time": "1958-09-10T00:50:51.715Z", "end_time": -86863450.36978698, "finish_state": "success", "retrySettings": null, "type": "operation", "actor": "job", "groups": [ "0e6db14dc86edcee41689950", { "_id": "bf401bc96ab42d6f0356825e", "provenance": "labore amet", "name": "sit esse enim voluptate", "description": "Excepteur dolore", "memberOf": [ { "groupId": "5f9cb9eb67b9bd59948ea3cb", "aaaManaged": true }, { "groupId": "0adf7955630f37956f9f9ba3", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "occaecat consequat velit in" }, { "roleId": "amet cillum fugiat veniam" }, { "roleId": "officia laborum tempor anim fugiat" }, { "roleId": "sint ea" }, { "roleId": "reprehenderit in" } ], "inactive": true, "_meta": { "created": "1997-10-21T00:24:00.624Z", "updated": "2008-10-11T07:27:06.541Z", "migrationVersion": -23392438 } } ], "iterations": [] }, "9e3": { "actor": "Pronghorn", "groups": [ { "_id": "1e49335a2c128beb162a232a", "provenance": "ipsum", "name": "ut amet Lorem pariatur", "description": "pariatur", "memberOf": [ { "groupId": "d64269789c2974e456d66e9f", "aaaManaged": true }, { "groupId": "49f1c59805c10f9f8d91d01b", "aaaManaged": false }, { "groupId": "dd9e28eb08ccae50571fab75", "aaaManaged": true }, { "groupId": "be288026d73e4e144bab063a", "aaaManaged": false }, { "groupId": "a79ee10d55df6bfc30d5dfa0", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "reprehenderit voluptate tempor" } ], "inactive": true, "_meta": { "created": "1963-04-25T04:05:00.154Z", "updated": "1999-03-27T21:51:01.2Z", "migrationVersion": -66881330 } } ], "iterations": [], "x": -70347690.86992219, "y": 66068857.44873878, "gridCoordinate": { "x": 61945842.96133536, "y": 16920266.858310476 }, "name": "et sunt aliquip esse qui", "location": "Broker", "locationType": null, "app": "sunt enim fugiat quis", "canvasName": "Lorem eiusmod in cillum", "displayName": "in anim dolor dolore mollit", "summary": "tempor anim incididunt eu", "description": "minim sit occaecat anim", "variables": { "error": "", "decorators": [ { "type": "encryption", "pointer": "/~0/~0/~0/~0/tMfTriysw14/JT6fOMC,/FDHR,HaDfG" }, { "type": "encryption", "pointer": "/gVuim" } ] }, "deprecated": true, "scheduled": true, "matched": [ { "key": "sit sunt ad dolore", "highlightString": "velit adipisicing ullamco voluptate eiusmod" }, { "key": "ut", "highlightString": "ea" }, { "key": "ut elit tempor sint eu", "highlightString": "mollit ut voluptate fugiat" } ], "status": "failure", "previous": { "incomplete": [ "error_handler" ], "complete": [ "error_handler" ], "error": [ "workflow_start", "workflow_start" ] }, "taskId": "e28f", "transitions": { "success": [ { "task": "workflow_end", "type": "loop" }, { "task": "workflow_end", "type": "standard" }, { "task": "workflow_start", "type": "revert" }, { "task": "workflow_start", "type": "revert" }, { "task": "e28f", "type": "standard" } ], "failure": [ { "task": "3a1f", "type": "revert" }, { "task": "e28f", "type": "revert" }, { "task": "workflow_end", "type": "standard" } ], "error": [ { "task": "error_handler", "type": "loop" }, { "task": "error_handler", "type": "loop" } ] }, "serverId": "exercitation ea", "start_time": "2013-11-27T17:42:19.465Z", "end_time": -25993492.430591524, "finish_state": "failure", "retrySettings": { "state": [ "error", "failure", "failure" ], "autoRetry": false, "limit": 94783920, "delay": 10095927, "count": 95830192, "finishedRetrying": false }, "type": "manual", "view": "mollit ullamco exercitation" } }, "parent": { "task": "ut commodo veniam in", "iteration": -33570312.48066753, "element": 80723192.67186591 }, "errorHandler": { "actor": null, "groups": [ "ad4730d51f7553b288a184ab", "default" ], "iterations": [ "8bECed18-F2Be-7B4F-eD52-2bbf7d1E2F55", "cD11AABa-6028-B1Bf-32fb-dedaedA6C696" ], "x": 81909075.56533816, "y": 71903766.36772004, "gridCoordinate": { "x": 249726.71778917313, "y": 71672890.42005262 }, "name": "reprehenderit deserunt", "location": "Adapter", "locationType": "do occaecat ut aute", "app": "est consequat", "canvasName": "officia sint", "displayName": "sunt id culpa", "summary": "et id exercitation sit do", "description": "deserunt Excepteur minim elit", "variables": { "error": "", "decorators": [ { "type": "encryption", "pointer": "/~0/~1/JyUY+xKd/~0/~1/fhp9D/dgI8FLy/K7JXWabL" }, { "type": "encryption", "pointer": "/~1" }, { "type": "encryption", "pointer": "/O--Yno2o6pi/~1/~1/D0LOQMH/X/M/FQWzSL/upD" } ] }, "deprecated": false, "scheduled": false, "matched": [ { "key": "ut dolore", "highlightString": "et commodo deserunt laborum do" }, { "key": "consequat pariatur dolore velit", "highlightString": "adipisicing" }, { "key": "pariatur eu in", "highlightString": "in commodo ut sint adipisicing" }, { "key": "ullamco", "highlightString": "aliquip in officia voluptate do" }, { "key": "voluptate ad", "highlightString": "magna aliqua" } ], "status": "failure", "previous": { "incomplete": [ "workflow_start", "workflow_end", "error_handler", "e28f", "workflow_end" ], "complete": [ "error_handler", "workflow_end", "workflow_end" ], "error": [ "error_handler", "workflow_start", "workflow_start", "e28f", "e28f" ] }, "taskId": "error_handler", "transitions": { "success": [ { "task": "workflow_end", "type": "revert" } ], "failure": [ { "task": "workflow_start", "type": "revert" } ], "error": [ { "task": "workflow_start", "type": "standard" }, { "task": "3a1f", "type": "revert" }, { "task": "e28f", "type": "revert" } ] }, "serverId": "proident esse Lorem", "start_time": "1996-03-31T21:41:41.799Z", "end_time": -33062964.217167944, "finish_state": "error", "retrySettings": null, "type": "manual", "view": "ex sit" }, "groups": [ { "_id": "847fd2058a918cf4e71b6a17", "provenance": "deserunt ullamco nulla dolor Excepteur", "name": "sint in exercitation pariatur", "description": "aliquip", "memberOf": [ { "groupId": "ce0e4f9fcf0ac22764490ada", "aaaManaged": true }, { "groupId": "020e2dde7e2a4a22456e2de7", "aaaManaged": true }, { "groupId": "9eec717ea1e7552c6477b182", "aaaManaged": false }, { "groupId": "4ab42f121d69a32ef18a4dae", "aaaManaged": false }, { "groupId": "dee3c35997c71f57d9f3e7d1", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "Duis culpa" }, { "roleId": "dolor" } ], "inactive": true, "_meta": { "created": "1985-10-06T08:05:18.618Z", "updated": "1956-12-25T16:35:46.703Z", "migrationVersion": 30610418 } }, "default", "default", "425b03a803fdcf9b1c461d7f", "default" ], "watchers": [ "Pronghorn", null, null, "a7535d68075329ef2ee581f5" ], "metrics": { "start_time": 31117850.02063887, "progress": 0.37977412662995924, "end_time": 54865861.01697463, "user": "Pronghorn", "owner": "Pronghorn" } } }
{ "title": "job", "allOf": [ { "$ref": "common-api#/definitions/success-response" }, { "type": "object", "properties": { "data": { "$ref": "job-api" } } } ] }