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": "dolor magna", "options": { "description": "Example job description", "type": "automation", "groups": [ "1b25691539ac7b096359d31a", "85d066046b1b773727d7f6f9" ] } }
{ "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": "621fa07543285e1e3741498a", "font_size": -29347838, "type": "automation", "created": "1963-06-07T09:51:12.978Z", "last_updated": "1968-01-20T14:38:37.116Z", "createdVersion": "167.30562907.2", "lastUpdatedVersion": "460458747.3.32948", "canvasVersion": 1, "encodingVersion": 1, "migrationVersion": -60295643, "name": "myCoolDocumentName", "description": null, "preAutomationTime": -90565006.69171062, "sla": -62259325.98268127, "decorators": [ { "type": "encryption", "pointer": "/~0/tm02pM0Ni/~0/~1/~1" }, { "type": "encryption", "pointer": "/HqE/oAxcky/i5uMr-EojP/z86/~0/~1/C7QM/KvtX3Bn-/~0" } ], "status": "error", "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 } ], "warnings": [ { "task": "workflow_start", "name": "myCoolDocumentName" }, { "task": "error_handler", "name": "myCoolDocumentName" }, { "task": "workflow_start", "name": "myCoolDocumentName", "message": "eu qui dolor Ut dolor" }, { "task": "3a1f", "name": "myCoolDocumentName", "message": "culpa sint enim" }, { "task": "3a1f", "name": "myCoolDocumentName" } ], "ancestors": null, "validationErrors": [ { "keyword": "labore ad", "dataPath": "eu non id", "schemaPath": "est velit Excepteur anim consequat", "message": "laboris tempor ea labore id" }, { "keyword": "do", "dataPath": "laboris", "schemaPath": "nostrud sunt", "message": "ex magna Ut et" }, { "keyword": "laboris amet est ex", "dataPath": "magna qui", "schemaPath": "cupidatat", "message": "anim veniam Lorem fugiat in" }, { "keyword": "in", "dataPath": "aliqua", "schemaPath": "nostrud fugiat", "message": "eiusmod enim" }, { "keyword": "dolor", "dataPath": "in nisi nulla exercitation", "schemaPath": "tempor", "message": "dolore sint voluptate cupidatat" } ], "created_by": "0a90af9ee8c9e6f45f222ed7", "last_updated_by": "Pronghorn", "tasks": { "workflow_start": { "x": -74737564.70238508, "y": -92270724.6646235, "gridCoordinate": { "x": 20292051.072438613, "y": -25424325.01078573 }, "name": "workflow_start", "summary": "workflow_start", "taskId": "workflow_start", "metrics": { "start_time": 9608136.133227736, "finish_state": "success", "user": { "_id": "5752904eb0d4fd0cc3d198cc", "provenance": "minim eiusmod commodo ex mollit", "username": "esse cupidatat nulla", "firstname": "et fugiat", "memberOf": [ { "groupId": "04090a48eee0240bae10cc76", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "laborum mollit consequat" }, { "roleId": "veniam Lorem aliqua et" }, { "roleId": "minim ex in elit" } ], "inactive": false, "lastLogin": "1977-06-15T06:31:59.441Z", "_meta": { "created": "2012-08-06T07:18:11.866Z", "updated": "1973-10-02T13:30:26.983Z", "migrationVersion": 11517001 }, "email": "eiusmod" } }, "groups": [ { "_id": "2b26fdf72c824c4c59395c9c", "provenance": "laborum fugiat deserunt tempor occaecat", "name": "veniam ullamco reprehenderit commodo", "description": "amet veniam consequat esse", "memberOf": [ { "groupId": "e3fa82d36515a84f1e50d834", "aaaManaged": false }, { "groupId": "0f1c0d2a90cf2cf083ae7610", "aaaManaged": false }, { "groupId": "d5f101a0b2ad91ee29d509cf", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "sunt qui" }, { "roleId": "enim non incididunt" }, { "roleId": "fugiat pariatur velit consectetur non" }, { "roleId": "dolore" }, { "roleId": "in occaecat" } ], "inactive": true, "_meta": { "created": "1958-04-18T16:04:11.161Z", "updated": "1985-05-11T05:08:01.195Z", "migrationVersion": 62123456 } } ], "iterations": [] }, "workflow_end": { "x": 36751363.92443904, "y": -39778146.667993575, "gridCoordinate": { "x": -40037039.01684723, "y": -2828869.770097956 }, "name": "workflow_end", "summary": "workflow_end", "taskId": "workflow_end", "endTasks": { "incomplete": [ "error_handler" ], "complete": [ "e28f", "error_handler", "workflow_start", "workflow_start", "error_handler" ], "error": [ "workflow_end" ] }, "metrics": { "end_time": 63591531.07507485, "run_time": 5175362.414398283 }, "groups": [ { "_id": "54d2b6cd83a7792fd1508a72", "provenance": "qui proident Ut irure non", "name": "fugiat", "description": "culpa eiusmod esse", "memberOf": [ { "groupId": "341209462e95eb41a4477385", "aaaManaged": true }, { "groupId": "778cae6da8573ad4497e9470", "aaaManaged": false }, { "groupId": "341479804d1a3cb136a05b46", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "incididunt amet minim aliquip" }, { "roleId": "Excepteur laboris non" } ], "inactive": true, "_meta": { "created": "1996-01-06T19:16:45.332Z", "updated": "1975-03-04T05:21:49.489Z", "migrationVersion": 20562754 } }, "default", "default" ], "iterations": [ "BeB0b841-EdBb-0E41-226e-Ed604A9F9B19" ] }, "error_handler": { "x": -4018759.9438144416, "y": -50742540.22259277, "gridCoordinate": { "x": -26918254.90644449, "y": -59085172.26296448 }, "name": "childJob", "location": "Adapter", "locationType": "laboris voluptate commodo esse dolor", "app": "eiusmod in commodo dolore labore", "canvasName": "sunt Duis in", "displayName": "aliquip pariatur sit magna", "summary": "consequat tempor cillum", "description": "ut anim Ut", "variables": { "error": "", "decorators": [ { "type": "encryption", "pointer": "/~1/~1/vJ..i4f/Pxqf/t/yw/SJ/~1/xtlTwkX54IF/XBulA+/isvZ5lJIBBI" } ] }, "deprecated": false, "scheduled": false, "matched": [ { "key": "proident Ut", "highlightString": "et ad nulla proident" }, { "key": "cupidatat nisi ad Ut", "highlightString": "qui dolore ut" } ], "status": "canceled", "previous": { "incomplete": [ "workflow_start", "workflow_start", "error_handler" ], "complete": [ "workflow_start", "e28f", "workflow_start", "e28f", "workflow_end" ], "error": [ "3a1f", "error_handler", "e28f", "workflow_end" ] }, "taskId": "workflow_start", "transitions": { "success": [ { "task": "workflow_start", "type": "loop" } ], "failure": [ { "task": "workflow_end", "type": "revert" }, { "task": "e28f", "type": "standard" }, { "task": "workflow_start", "type": "standard" } ], "error": [ { "task": "error_handler", "type": "standard" }, { "task": "workflow_end", "type": "loop" }, { "task": "error_handler", "type": "revert" }, { "task": "workflow_start", "type": "standard" }, { "task": "error_handler", "type": "standard" } ] }, "serverId": "consectetur occaecat enim", "start_time": "1990-07-13T18:25:20.823Z", "end_time": 90158087.50411353, "finish_state": "success", "retrySettings": { "state": [ "error", "success" ], "autoRetry": false, "limit": 10453848, "delay": 96712478, "count": 26476904, "finishedRetrying": true }, "type": "operation", "actor": "job", "groups": [ "default", "default", "default", "1ee1bc02407b81541e3cbb3c" ], "iterations": [ "d171f94E-3954-71Ed-8aD8-08F49aaABCBF", "f32e712D-8EAc-8Ff1-A46c-75CD5eAc7bAC" ] }, "e": { "x": -29697622.233364165, "y": -77241204.21614176, "gridCoordinate": { "x": -70665434.71303576, "y": 34990833.52744487 }, "name": "magna pariatur consectetur occaecat", "location": "Application", "locationType": "occaecat", "app": "aliqua et dolor sed ea", "canvasName": "nostrud velit tempor et culpa", "displayName": "incididunt nisi est", "summary": "nisi in commodo", "description": "non in tempor et", "variables": { "error": "", "decorators": [ { "type": "encryption", "pointer": "/dVem" }, { "type": "encryption", "pointer": "/q8WlGjf/l-P" }, { "type": "encryption", "pointer": "/aBI/~1/~0/BlgZtFawF1w/~0/jzXqEnZ/sr/ncWvR" } ] }, "deprecated": false, "scheduled": true, "matched": [ { "key": "sint sit", "highlightString": "tempor" }, { "key": "amet", "highlightString": "in consectetur quis" }, { "key": "Ut", "highlightString": "ex aliquip pariatur consectetur sed" } ], "status": "scheduled", "previous": { "incomplete": [ "workflow_start" ], "complete": [ "e28f", "workflow_end", "workflow_start", "e28f" ], "error": [ "e28f", "workflow_end", "workflow_end" ] }, "taskId": "workflow_start", "transitions": { "success": [ { "task": "3a1f", "type": "loop" }, { "task": "workflow_start", "type": "standard" }, { "task": "e28f", "type": "loop" }, { "task": "e28f", "type": "standard" }, { "task": "workflow_end", "type": "loop" } ], "failure": [ { "task": "e28f", "type": "loop" } ], "error": [ { "task": "error_handler", "type": "standard" }, { "task": "workflow_end", "type": "loop" }, { "task": "workflow_start", "type": "revert" } ] }, "serverId": "nostrud dolore", "start_time": "1961-04-07T13:26:40.408Z", "end_time": -37413254.713934354, "finish_state": "success", "retrySettings": null, "type": "operation", "actor": null, "groups": [ "a2731c4b3a46a614f2a5f019", "default", { "_id": "8b70e2e46144d6925429021f", "provenance": "ea officia commodo nulla voluptate", "name": "Lorem ut", "description": "nostrud ut elit", "memberOf": [ { "groupId": "fca27f37691e9a34c93b6fde", "aaaManaged": false }, { "groupId": "1b36365cb91c1d65b12507b5", "aaaManaged": true }, { "groupId": "6605f033d9a838d72afa69f7", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "consequat" }, { "roleId": "proident" }, { "roleId": "veniam" }, { "roleId": "dolor dolore" } ], "inactive": true, "_meta": { "created": "1964-07-01T04:41:32.768Z", "updated": "1975-06-15T13:50:29.99Z", "migrationVersion": 80304397 } }, "e8e3e594cc1c69ca11061299", { "_id": "86aa1deaf0cf68385fa36677", "provenance": "sit", "name": "ut quis", "description": "aute", "memberOf": [ { "groupId": "4bb0638d403d48bcf61b2ee3", "aaaManaged": true }, { "groupId": "2881ed2292f547ef4e9411f7", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "pariatur Excepteur laboris ex incididunt" }, { "roleId": "fugiat" }, { "roleId": "sit ut consequat" }, { "roleId": "magna amet" }, { "roleId": "consectetur ipsum" } ], "inactive": false, "_meta": { "created": "1948-01-15T17:03:41.967Z", "updated": "1991-09-06T11:55:22.851Z", "migrationVersion": 11226466 } } ], "iterations": [ "9925b37c-ddCC-DD36-A841-9DB8Bb6AacBd", "5eBeCcFe-aE3f-A4D4-ED0B-6A54aB992c25" ] } }, "parent": { "task": "exercitation do consectetur quis qui", "iteration": -65756878.2127695, "element": -75756147.30463713 }, "errorHandler": { "x": 3250965.5148043483, "y": 67830346.66253048, "gridCoordinate": { "x": 55847501.74410176, "y": -77907503.49551763 }, "name": "sint occaecat", "location": "Broker", "locationType": null, "app": "dolor", "canvasName": "ut aute", "displayName": "in in", "summary": "proident minim cupidatat", "description": "ipsum", "variables": { "error": "", "decorators": [ { "type": "encryption", "pointer": "/~0/Yen+K/lD6rtWRvj/~1/s3/gnLgcv//~0/IEJLMgmVvZe/qI" }, { "type": "encryption", "pointer": "/nelVY59x,m/gVj,pkg/V/XhWuC//~0/H/LRwffZ8Bl" } ] }, "deprecated": false, "scheduled": true, "matched": [ { "key": "fugiat", "highlightString": "sint veniam" }, { "key": "dolor", "highlightString": "laborum irure est qui" }, { "key": "Duis adipisicing ex ut sit", "highlightString": "elit eiusmod" }, { "key": "consequat", "highlightString": "consequat occaecat enim ad do" } ], "status": "canceled", "previous": { "incomplete": [ "error_handler" ], "complete": [ "3a1f", "workflow_start", "e28f", "workflow_start" ], "error": [ "workflow_start", "3a1f", "workflow_start" ] }, "taskId": "workflow_start", "transitions": { "success": [ { "task": "workflow_start", "type": "revert" } ], "failure": [ { "task": "e28f", "type": "loop" }, { "task": "e28f", "type": "loop" }, { "task": "workflow_start", "type": "revert" } ], "error": [ { "task": "3a1f", "type": "revert" }, { "task": "workflow_end", "type": "standard" }, { "task": "e28f", "type": "revert" }, { "task": "workflow_start", "type": "loop" } ] }, "serverId": "ea aute minim", "start_time": "1971-06-30T03:49:14.099Z", "end_time": -68683692.41099907, "finish_state": "error", "retrySettings": { "state": [ "success", "success", "error", "failure", "failure" ], "autoRetry": true, "limit": 98121758, "delay": 28928485, "count": 18087072, "finishedRetrying": false }, "type": "operation", "actor": "Pronghorn", "groups": [ { "_id": "80c0815c2dfe04b7bf88d997", "provenance": "voluptate in", "name": "esse", "description": "veniam culpa sunt", "memberOf": [ { "groupId": "99943a71e4511df768e8df9a", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "ut cillum amet dolore" }, { "roleId": "sunt ea minim" }, { "roleId": "mollit exercitation esse" } ], "inactive": false, "_meta": { "created": "1984-02-06T06:01:10.497Z", "updated": "1973-10-23T14:28:32.508Z", "migrationVersion": 9743945 } }, "default", { "_id": "f8d801140411034d374e0f65", "provenance": "id aliquip", "name": "aliqua reprehenderit", "description": "cupidatat", "memberOf": [ { "groupId": "045c5ee52976f9da73409b83", "aaaManaged": false }, { "groupId": "019c9aae747a39b8377b2869", "aaaManaged": true }, { "groupId": "b6371ebb06bd803c6972382e", "aaaManaged": true }, { "groupId": "8b0ac645fcc294b44e233d87", "aaaManaged": true }, { "groupId": "8d5d442c605c4a6c5f01b094", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "tempor dolore fugiat id anim" }, { "roleId": "mollit laboris non" }, { "roleId": "enim irure cupidatat" }, { "roleId": "culpa sed" } ], "inactive": true, "_meta": { "created": "2011-03-24T02:09:54.733Z", "updated": "1982-10-17T13:28:18.56Z", "migrationVersion": 47334578 } } ], "iterations": [ "84e2ED8a-EBEc-c2D7-377B-5Dcdd825B21F" ] }, "groups": [ "default", "37a2fc5e93f6585bbb3d07b9", "34f452af635ab979192c0e86" ], "watchers": [ null, { "_id": "ff215b23ed87f4507f215d02", "provenance": "pariatur non", "username": "ullamco dolore", "firstname": "nostrud tempor sint magna", "memberOf": [ { "groupId": "3dc17ab0e24b40af59b63d27", "aaaManaged": true }, { "groupId": "b3757c631fbe7f444167cf24", "aaaManaged": false }, { "groupId": "572e01d11deb614628c2e4d4", "aaaManaged": true }, { "groupId": "e58f1dec01d4d57efbf5e956", "aaaManaged": true }, { "groupId": "d3078f11defb14deebdc14f7", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "incididunt est ex sit" }, { "roleId": "occaecat" }, { "roleId": "Excepteur sint" }, { "roleId": "aliqua adipisicing" }, { "roleId": "cillum labore pariatur" } ], "inactive": true, "lastLogin": "2000-09-22T21:51:17.379Z", "_meta": { "created": "2003-02-28T01:40:18.86Z", "updated": "1947-05-08T12:20:09.592Z", "migrationVersion": -47384979 }, "email": "in eu Duis occaecat" }, { "_id": "265e2348521784c27b68c89b", "provenance": "Excepteur sed occaecat", "username": "pariatur", "firstname": "commodo consequat aute", "memberOf": [ { "groupId": "98ece87c4417408f182c6cc6", "aaaManaged": false }, { "groupId": "3fb92ec97ef55ac297179b50", "aaaManaged": false }, { "groupId": "38e7f59e5debef3c4e910921", "aaaManaged": true }, { "groupId": "a273cf0691eb8d8bd412d387", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "exercitation ut laborum" } ], "inactive": true, "lastLogin": "1982-04-01T05:00:33.359Z", "_meta": { "created": "2025-09-11T17:09:41.639Z", "updated": "2011-09-21T22:16:05.905Z", "migrationVersion": -52505349 }, "email": "et Excepteur fugiat ea aliquip" }, "5bbc803cd2f767afc6887a92", "1133b353afc409b53d8086aa" ], "metrics": { "start_time": 72190515.2647562, "progress": 0.6924379849989519, "end_time": 317786.382552132, "user": { "_id": "41c88e6f0c004ab017abfa37", "provenance": "exercitation cupidatat elit", "username": "dolore Ut amet est velit", "firstname": "non in in occaecat sunt", "memberOf": [ { "groupId": "e102b45599de673ede5ab982", "aaaManaged": false }, { "groupId": "f44d6b90f2f667832846249a", "aaaManaged": false }, { "groupId": "795658c9b125a60cc5b401db", "aaaManaged": true }, { "groupId": "566ce85187880cc4f80803e3", "aaaManaged": false }, { "groupId": "ebbdccf522b2cd81b592d2ca", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "ad" }, { "roleId": "est occaecat veniam enim" }, { "roleId": "ad do deserunt consectetur" } ], "inactive": false, "lastLogin": "1994-08-20T21:50:11.875Z", "_meta": { "created": "1953-05-06T07:54:43.873Z", "updated": "2023-09-21T09:12:00.909Z", "migrationVersion": -28343351 }, "email": "ad amet" }, "owner": "Pronghorn" } } }
{ "title": "job", "allOf": [ { "$ref": "common-api#/definitions/success-response" }, { "type": "object", "properties": { "data": { "$ref": "job-api" } } } ] }