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": "Duis", "options": { "description": "Example job description", "type": "automation", "groups": [ "2a1162c9a46c826ccaf48aac", "e8cebffc783ead6f2cc815f4", "b8005f9f4814ef89037a7f68" ] } }
{ "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": "5347da0a4524cdf48078d065", "font_size": 35423416, "type": "resource:action", "created": "1968-10-27T20:46:22.54Z", "last_updated": "1978-09-30T17:59:54.344Z", "createdVersion": "1.9.96-0342.673.7296582333.861", "lastUpdatedVersion": "97811.442734.42918135", "canvasVersion": 2, "encodingVersion": 1, "migrationVersion": -8559062, "name": "myCoolDocumentName", "description": null, "preAutomationTime": -41689020.263020724, "sla": 32966168.477887154, "decorators": [ { "type": "encryption", "pointer": "/~1/~0" }, { "type": "encryption", "pointer": "/~0/~0" }, { "type": "encryption", "pointer": "/~0" }, { "type": "encryption", "pointer": "/eUmV/amqFPj+gbq/~1/~0/Uo/aFRN-a/~1/sAK" }, { "type": "encryption", "pointer": "/~1/~0/Z/UC/w7kCrLw/~0/HfM4kb" } ], "status": "running", "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": "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": "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 } ], "warnings": [ { "task": "3a1f", "name": "myCoolDocumentName", "message": "magna esse dolore" }, { "task": "workflow_start", "name": "myCoolDocumentName" }, { "task": "workflow_start", "name": "myCoolDocumentName" }, { "task": "workflow_start", "name": "myCoolDocumentName", "message": "enim ad sed" } ], "ancestors": null, "validationErrors": [ { "keyword": "eu elit incididunt", "dataPath": "labore consectetur Excepteur", "schemaPath": "ut Excepteur tempor est", "message": "enim ea" }, { "keyword": "occaecat qui", "dataPath": "Duis quis aute", "schemaPath": "incididunt nisi dolor", "message": "anim nisi dolor aliquip in" }, { "keyword": "in ex", "dataPath": "sunt aliquip in", "schemaPath": "non officia", "message": "officia consequat anim Lorem id" }, { "keyword": "dolor est enim deserunt", "dataPath": "in anim qui dolore", "schemaPath": "consequat", "message": "nulla ullamco in" } ], "created_by": "1ccfd975fa8b4b1ff20d14b8", "last_updated_by": null, "tasks": { "workflow_start": { "x": 86799548.46432215, "y": -69234948.5635515, "gridCoordinate": { "x": -39900319.14140561, "y": 46229193.079557925 }, "name": "workflow_start", "summary": "workflow_start", "taskId": "workflow_start", "metrics": { "start_time": -35733235.90706736, "finish_state": "success", "user": null }, "groups": [ { "_id": "fcbfe0e84e676a120af82546", "provenance": "esse ea", "name": "commodo incididunt", "description": "non et voluptate", "memberOf": [ { "groupId": "092f8da96a7d07c8c7d2b158", "aaaManaged": true }, { "groupId": "78c4f106d91fe957a38f3122", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "dolor ut" } ], "inactive": true, "_meta": { "created": "2022-08-13T22:53:42.019Z", "updated": "1955-01-04T23:33:16.631Z", "migrationVersion": -44400995 } } ], "iterations": [] }, "workflow_end": { "x": 5514796.56502907, "y": 36557723.79403931, "gridCoordinate": { "x": -2960213.6392656863, "y": 94682191.17039225 }, "name": "workflow_end", "summary": "workflow_end", "taskId": "workflow_end", "endTasks": { "incomplete": [ "workflow_start" ], "complete": [ "workflow_start", "workflow_start", "e28f", "workflow_start", "3a1f" ], "error": [ "workflow_start", "workflow_start", "workflow_start", "workflow_start", "workflow_start" ] }, "metrics": { "end_time": 4320991.871633545, "run_time": 26994872.96714285 }, "groups": [ "6b465a63ced6e9c71fd94d63", "default", { "_id": "44bc378b2bfc4994ebd5e122", "provenance": "proident", "name": "sit aliqua laboris", "description": "sint", "memberOf": [ { "groupId": "6aae51483a6d33f1aaf258ef", "aaaManaged": false }, { "groupId": "1f3343519b4c9041acd1f444", "aaaManaged": true }, { "groupId": "c870da9119ade9dd325c53bd", "aaaManaged": true }, { "groupId": "87cb74390c5511381c3ad870", "aaaManaged": true }, { "groupId": "97f0f0773226a729e982ac39", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "ex cupidatat amet" }, { "roleId": "voluptate mollit irure deserunt eiusmod" }, { "roleId": "ipsum mollit nisi" }, { "roleId": "pariatur in veniam mollit" }, { "roleId": "aliquip est esse ipsum sunt" } ], "inactive": true, "_meta": { "created": "2000-09-27T00:15:37.834Z", "updated": "2002-09-24T10:09:02.597Z", "migrationVersion": 55745356 } }, "108874ad7dd63a83ce96e5f9" ], "iterations": [ "bCE1EdEf-7dd9-B528-5dfA-40B76DcAF8e5", "70Fdeebc-c6c4-Ca8b-A47c-e12afD40A1DC" ] }, "error_handler": { "x": 58154726.27047345, "y": -68427670.11958575, "gridCoordinate": { "x": -15729814.772762433, "y": 2286166.6524939537 }, "name": "childJob", "location": "Application", "locationType": "amet Lorem dolor", "app": "minim Ut nostrud cupidatat reprehenderit", "canvasName": "non aliqua fugiat labore enim", "displayName": "occaecat non aliqua do", "summary": "sit nostrud", "description": "veniam consequat tempor sed ullamco", "variables": { "error": "", "decorators": [ { "type": "encryption", "pointer": "/~0/~1/UAM,tMXv/~0/~1" }, { "type": "encryption", "pointer": "/UXS" } ] }, "deprecated": true, "scheduled": false, "matched": [ { "key": "in aute magna dolore", "highlightString": "quis occaecat laboris cillum" }, { "key": "ipsum cillum occaecat id", "highlightString": "cillum laboris id" }, { "key": "veniam", "highlightString": "id ipsum Lorem Excepteur" }, { "key": "proident velit sit in laboris", "highlightString": "sint nostrud occaecat aute deserunt" }, { "key": "Duis commodo occaecat ipsum", "highlightString": "consequat quis amet eu" } ], "status": "canceled", "previous": { "incomplete": [ "workflow_start", "3a1f", "error_handler", "e28f", "3a1f" ], "complete": [ "error_handler" ], "error": [ "workflow_start", "error_handler", "3a1f", "error_handler", "e28f" ] }, "taskId": "workflow_start", "transitions": { "success": [ { "task": "3a1f", "type": "standard" }, { "task": "error_handler", "type": "revert" }, { "task": "workflow_start", "type": "revert" } ], "failure": [ { "task": "3a1f", "type": "standard" }, { "task": "e28f", "type": "revert" }, { "task": "workflow_start", "type": "revert" }, { "task": "workflow_start", "type": "revert" }, { "task": "workflow_end", "type": "loop" } ], "error": [ { "task": "3a1f", "type": "revert" }, { "task": "workflow_start", "type": "revert" } ] }, "serverId": "exercitation in mollit nulla", "start_time": "1999-04-30T18:25:48.963Z", "end_time": 97452878.82318085, "finish_state": "success", "retrySettings": { "state": [ "error", "success" ], "autoRetry": false, "limit": 37384394, "delay": 26588524, "count": 50072072, "finishedRetrying": false }, "type": "operation", "actor": "ca905f80f106ba439004ff97", "groups": [ "default", "c27ce91e2668b7dbdac95cba", "default", "default", { "_id": "4746126811c6a4ec16bb0c0d", "provenance": "esse ad do occaecat", "name": "nisi in", "description": "nostrud culpa reprehenderit", "memberOf": [ { "groupId": "18e0a52c74534695c6e1ea85", "aaaManaged": true }, { "groupId": "d814ec020eb79cdaeddcadb3", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "ullamco amet aute dolore laborum" }, { "roleId": "in Duis" }, { "roleId": "labore in quis" }, { "roleId": "proident" } ], "inactive": false, "_meta": { "created": "2016-09-14T03:25:42.764Z", "updated": "2003-05-22T16:25:16.051Z", "migrationVersion": -73390080 } } ], "iterations": [] }, "17ed": { "actor": "Pronghorn", "groups": [ { "_id": "c48945669a4eecad59d85905", "provenance": "occaecat", "name": "ut reprehenderit", "description": "commodo adipisicing in nostrud", "memberOf": [ { "groupId": "02c49c3ceb539fdf03714072", "aaaManaged": false }, { "groupId": "21a772ae195c21f3fa089642", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "ut" }, { "roleId": "amet in et" }, { "roleId": "fugiat in deserunt" }, { "roleId": "dolor nisi" }, { "roleId": "laborum" } ], "inactive": false, "_meta": { "created": "1998-01-01T08:28:26.592Z", "updated": "1962-03-03T21:17:38.173Z", "migrationVersion": -54176883 } } ], "iterations": [], "x": 50371669.33955911, "y": 69679299.1037727, "gridCoordinate": { "x": -31186180.7205085, "y": 51792756.73245996 }, "name": "mollit ut ullamco dolore", "location": "Broker", "locationType": "labore eiusmod", "app": "laboris", "canvasName": "childJob", "displayName": "in Lorem culpa Excepteur ipsum", "summary": "labore commodo non sint", "description": "ea fugiat eiusmod qui dolor", "variables": { "error": "", "decorators": [ { "type": "encryption", "pointer": "/~1/x/kEE/LHUf5/zzVu.K9" }, { "type": "encryption", "pointer": "/~0/ddJ9TV/k/vr/~0/~0" }, { "type": "encryption", "pointer": "/jNQ-czgpj58/H5XB/~0/~1/o2U4ZhPEQ/Lw1m,8SvPY" }, { "type": "encryption", "pointer": "/~0/g5D1y4qrAn/~0/dnS" }, { "type": "encryption", "pointer": "/oQRT+Bdq-n/~0/zoFMPW/H,/dCPC/chz" } ] }, "deprecated": false, "scheduled": false, "matched": [ { "key": "proident dolore", "highlightString": "aliqua eu" }, { "key": "commodo quis deserunt qui esse", "highlightString": "est irure velit occaecat exercitation" } ], "status": "failure", "previous": { "incomplete": [ "3a1f", "workflow_end", "e28f", "3a1f" ], "complete": [ "3a1f", "workflow_end", "error_handler", "workflow_start" ], "error": [ "e28f", "workflow_start", "e28f", "workflow_start" ] }, "taskId": "workflow_start", "transitions": { "success": [ { "task": "error_handler", "type": "standard" } ], "failure": [ { "task": "workflow_end", "type": "revert" }, { "task": "e28f", "type": "standard" }, { "task": "e28f", "type": "loop" }, { "task": "e28f", "type": "loop" }, { "task": "workflow_start", "type": "standard" } ], "error": [ { "task": "workflow_start", "type": "loop" } ] }, "serverId": "tempor consequat id reprehenderit", "start_time": "1968-09-01T06:52:44.636Z", "end_time": 72358584.4264012, "finish_state": "success", "retrySettings": { "state": [ "failure" ], "autoRetry": false, "limit": 86154432, "delay": 13919512, "count": 14618612, "finishedRetrying": false }, "loop": { "atLeastOneComplete": true, "finishedCount": -86953705.83078885, "outgoing": [ null, null ] }, "childJobs": [ { "_id": "in", "name": "esse elit sunt ipsum", "iteration": -23784901.81434025 }, { "_id": "commodo est et Lorem magna", "name": "qui magna", "iteration": -3697872.664699763 }, { "_id": "adipisicing ullamco quis", "name": "ullamco", "iteration": -39581132.94745615 }, { "_id": "sed", "name": "anim enim", "iteration": -6531189.366277918 } ] } }, "parent": { "job": "Lorem laborum adipisicing sint occaecat", "task": "ut", "iteration": 70623317.07814473, "element": 15217707.837992027 }, "errorHandler": { "actor": "job", "groups": [ { "_id": "1d3a4b5d7c2f20d44485ae4f", "provenance": "veniam ea officia mollit", "name": "et", "description": "pariatur non veniam dolor", "memberOf": [ { "groupId": "b5ebd51cec215aaa823cc9fa", "aaaManaged": true }, { "groupId": "8293530cc6ca847cf1a5b1d9", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "quis occaecat minim Excepteur" }, { "roleId": "deserunt ea adipisicing incididunt" }, { "roleId": "ullamco pariatur" }, { "roleId": "veniam" }, { "roleId": "sunt reprehenderit aute Duis" } ], "inactive": false, "_meta": { "created": "1997-07-12T04:37:10.603Z", "updated": "2008-01-01T21:41:55.626Z", "migrationVersion": -39856600 } }, { "_id": "2c177a07d37408210fcc3c2e", "provenance": "velit labore voluptate", "name": "enim ipsum", "description": "aliqua et laboris", "memberOf": [ { "groupId": "f0119a3603e65387294ad9df", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "in dolor consequat" }, { "roleId": "pariatur ex" }, { "roleId": "amet dolore eiusmod irure do" }, { "roleId": "deserunt Lorem qui" } ], "inactive": true, "_meta": { "created": "2006-11-20T01:23:36.188Z", "updated": "1992-04-02T05:02:31.395Z", "migrationVersion": -36436465 } }, { "_id": "742f179ddd729e15dca1e2c9", "provenance": "nisi sint aliqua nulla", "name": "cillum", "description": "labore culpa tempor", "memberOf": [ { "groupId": "13307224863909d242e51054", "aaaManaged": false }, { "groupId": "d910e3a4b8e4c15067a5a42b", "aaaManaged": true }, { "groupId": "7f1aa3bc028cb2875b40b0d9", "aaaManaged": false }, { "groupId": "1e0772f77cddeffafef1999d", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "tempor" }, { "roleId": "commodo" }, { "roleId": "quis" }, { "roleId": "sed" }, { "roleId": "aliquip eu dolore" } ], "inactive": true, "_meta": { "created": "1978-05-17T23:59:00.29Z", "updated": "2005-09-18T11:32:22.942Z", "migrationVersion": -53716101 } }, { "_id": "23f132f68170b7a689292dd9", "provenance": "Lorem quis eu deserunt", "name": "sit mollit eiusmod in", "description": "nulla mollit ut sint", "memberOf": [ { "groupId": "62438b61a405091b1de2e5e8", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "ut veniam" } ], "inactive": true, "_meta": { "created": "1970-11-11T12:42:23.256Z", "updated": "1973-02-17T04:37:28.46Z", "migrationVersion": 14593759 } } ], "iterations": [], "x": 47864099.58065, "y": 2138197.0944688916, "gridCoordinate": { "x": -7420387.028017089, "y": 22289068.13952735 }, "name": "velit culpa", "location": "Adapter", "locationType": null, "app": "anim mollit adipisicing", "canvasName": "childJob", "displayName": "occaecat enim dolor ut elit", "summary": "tempor irure quis proident", "description": "fugiat exercitation est laborum consectetur", "variables": { "error": "", "decorators": [ { "type": "encryption", "pointer": "/fFBiTM/~1/Il2dg2/~1/~0/~0/~0/~0/~1" }, { "type": "encryption", "pointer": "/aZmMC/FrsN7v//~0/M4pjvc0O/p/T0uC/BK/~1/~1/~1" }, { "type": "encryption", "pointer": "/Oefm7TJD/~1/~0/WyZf" }, { "type": "encryption", "pointer": "/cls9icfoc" } ] }, "deprecated": false, "scheduled": true, "matched": [ { "key": "elit eu laborum", "highlightString": "non deserunt anim" }, { "key": "dolor", "highlightString": "nisi mollit officia dolore cupidatat" }, { "key": "dolore veniam", "highlightString": "non consectetur eu mollit" }, { "key": "labore laborum", "highlightString": "et" } ], "status": "paused", "previous": { "incomplete": [ "workflow_end", "workflow_start" ], "complete": [ "workflow_end" ], "error": [ "3a1f", "workflow_end", "3a1f", "error_handler", "workflow_end" ] }, "taskId": "e28f", "transitions": { "success": [ { "task": "error_handler", "type": "revert" }, { "task": "3a1f", "type": "standard" }, { "task": "workflow_start", "type": "revert" }, { "task": "e28f", "type": "loop" }, { "task": "workflow_end", "type": "revert" } ], "failure": [ { "task": "3a1f", "type": "revert" }, { "task": "workflow_end", "type": "revert" } ], "error": [ { "task": "workflow_start", "type": "loop" }, { "task": "workflow_start", "type": "revert" }, { "task": "workflow_start", "type": "revert" }, { "task": "3a1f", "type": "revert" } ] }, "serverId": "sint non in et", "start_time": "1977-10-22T07:18:21.309Z", "end_time": -40411162.37993925, "finish_state": "error", "retrySettings": null, "loop": { "atLeastOneComplete": true, "finishedCount": -29765919.890757337, "outgoing": [ null, null, "laboris consequat commodo", "in dolore quis ullamco ex", null ] }, "childJobs": [ { "_id": "aute do id", "name": "proident sunt", "iteration": 43695914.254657716 }, { "_id": "do consectetur", "name": "irure", "iteration": -65998980.2951654 }, { "_id": "nisi amet aliqua laborum laboris", "name": "laborum nisi eu", "iteration": 80187593.52146357 }, { "_id": "cupidatat anim nostrud dolore in", "name": "ex magna do ea commodo", "iteration": -3966381.018149391 }, { "_id": "ipsum qui proident", "name": "aliquip cupidatat do", "iteration": 33362744.423118636 } ] }, "groups": [ { "_id": "35c417cfb4817abcf916daac", "provenance": "Ut ad esse", "name": "dolore Excepteur", "description": "sint est fugiat tempor laborum", "memberOf": [ { "groupId": "b12659b256797718607e7169", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "veniam" }, { "roleId": "esse" }, { "roleId": "cupidatat laboris aute" }, { "roleId": "est ut" }, { "roleId": "est ullamco pariatur dolore" } ], "inactive": true, "_meta": { "created": "1998-07-08T04:32:16.52Z", "updated": "1953-10-22T12:18:00.75Z", "migrationVersion": -10946061 } }, { "_id": "2bd843b94697db703f9951ed", "provenance": "cillum non eiusmod ad incididunt", "name": "eiusmod Ut", "description": "nulla tempor", "memberOf": [ { "groupId": "874f49f0219e337183066fe9", "aaaManaged": false }, { "groupId": "95270b8454bf1526f801d587", "aaaManaged": false }, { "groupId": "324148f852889faff4b26825", "aaaManaged": false }, { "groupId": "9cd175490cd4db4a7ab94ea1", "aaaManaged": true }, { "groupId": "06cda81c832041cfbb20cc91", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "adipisicing" }, { "roleId": "eiusmod eu id" }, { "roleId": "ipsum aliqua ad in" } ], "inactive": true, "_meta": { "created": "1949-01-01T23:21:43.616Z", "updated": "2015-05-08T01:58:33.192Z", "migrationVersion": -2027167 } }, "default", "default" ], "watchers": [ "cd78e362b3b0bafb26cc12e1", "cce6c8b84b4920670755d113", null ], "metrics": { "start_time": -11545439.691435263, "progress": 0.5059908348837696, "end_time": 92257859.29643565, "user": { "_id": "10cba4b717b81a083b20f5f1", "provenance": "ad", "username": "dolore aliquip", "firstname": "incididunt ut", "memberOf": [ { "groupId": "eb41b05a5384e34354071bd3", "aaaManaged": false }, { "groupId": "409cc6f3c5ad5252d4b91e4c", "aaaManaged": false }, { "groupId": "52ffe4d1dbcdd0727ed09137", "aaaManaged": true }, { "groupId": "3062165c0c314f651c666ab6", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "deserunt non ut dolor" } ], "inactive": true, "lastLogin": "1995-10-12T13:40:38.895Z", "_meta": { "created": "1959-06-24T21:53:32.761Z", "updated": "2003-05-17T03:46:26.458Z", "migrationVersion": 87753571 }, "email": "non Excepteur mollit dolor" }, "owner": "50d93d89d1e60c362ba2b89f" } } }
{ "title": "job", "allOf": [ { "$ref": "common-api#/definitions/success-response" }, { "type": "object", "properties": { "data": { "$ref": "job-api" } } } ] }