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": "cillum do", "options": { "description": "Example job description", "type": "automation", "groups": [ "b164fcd3c1c828f9c7451ddb", "ec2dc97a90dc4df98ddbbd6c", "0ba68f5e4a94f9dc54c04310", "7e6c8c7c00b1e0ec95f21172" ] } }
{ "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": "5e6c79af78e378e6225aed70", "uuid": "66316524-ab78-f99d-37ba-769bd87c5c4b", "font_size": -21170712, "type": "resource:compliance", "created": "2000-05-26T05:43:17.847Z", "last_updated": "1973-05-26T18:16:48.492Z", "createdVersion": "4.33425134461.710644602", "lastUpdatedVersion": "413580118.4157412873.31280179316-7801.93770386340.5.5532", "canvasVersion": 1.5, "encodingVersion": 1, "migrationVersion": -67884466, "name": "myCoolDocumentName", "description": null, "preAutomationTime": 65179855.26723641, "sla": 55801486.04358691, "decorators": [ { "type": "encryption", "pointer": "/~0/nWNjP/~0/nFatyWiJ4t/nit2SAU2yS2/B/~0/~1" } ], "status": "canceled", "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": "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": "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": "e28f", "name": "myCoolDocumentName" } ], "ancestors": [ "ad57c5ad97633cfb7b1e3621", "991e802092537081385d904d", "38db772329b95bf5a7f6b5d0" ], "validationErrors": [ { "keyword": "et est incididunt ut", "instancePath": "minim", "schemaPath": "veniam", "message": "culpa commodo exercitation quis" }, { "keyword": "aliquip enim", "instancePath": "voluptate", "schemaPath": "ut veniam minim incididunt Ut", "message": "ullamco qui cillum" }, { "keyword": "nisi laboris in sunt", "instancePath": "dolor in laboris velit", "schemaPath": "eu nostrud", "message": "qui in enim pariatur incididunt" }, { "keyword": "pariatur exercitation sed ad", "instancePath": "est reprehenderit ad officia", "schemaPath": "occaecat voluptate quis anim", "message": "do exercitation Lorem velit id" }, { "keyword": "veniam officia consequat proident mollit", "instancePath": "qui Excepteur", "schemaPath": "Ut sed fugiat sunt", "message": "aliquip ut" } ], "created_by": "1a95332c29588f24409ae8b9", "last_updated_by": null, "tasks": { "5039": { "actor": "job", "groups": [ { "_id": "8bb5f1df73a98bc11d4cf1e9", "provenance": "ullamco in anim dolor Duis", "name": "aute", "description": "sit irure", "memberOf": [ { "groupId": "5cbbdeb32ebc2a48e843d4ae", "aaaManaged": false }, { "groupId": "c839bc54f1583b4622cc089f", "aaaManaged": false }, { "groupId": "8184fbd005750cbc51cd3689", "aaaManaged": true }, { "groupId": "0dcef941b29f969f54e88895", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "do" } ], "inactive": false, "_meta": { "created": "1969-09-20T22:24:04.894Z", "updated": "1989-04-16T00:41:18.848Z", "migrationVersion": -9840925 } }, { "_id": "0c7d7b054a0fb8eff995a32b", "provenance": "pariatur sed", "name": "ea non", "description": "minim", "memberOf": [ { "groupId": "37e1ea06918e5e76e7c1f99c", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "dolor reprehenderit incididunt in cupidatat" }, { "roleId": "reprehenderit commodo et" }, { "roleId": "ex sit aute adipisicing velit" } ], "inactive": false, "_meta": { "created": "1983-08-25T04:04:56.974Z", "updated": "1952-05-22T06:51:47.401Z", "migrationVersion": 68750637 } } ], "iterations": [ "0515Dcac-8025-53B0-BA02-eB3b38Dba2da", "55AAA48C-bBB8-aB8B-DDC0-C6F4FD886AF3" ], "x": -2017839.9276016206, "y": -48159287.18790987, "gridCoordinate": { "x": 86362530.60588306, "y": -64055330.32801145 }, "name": "in", "location": "Application", "locationType": null, "app": "ea ipsum ullamco tempor sed", "canvasName": "ea voluptate sit nisi", "displayName": "Duis", "summary": "et mollit minim eiusmod", "description": "voluptate cupidatat ut", "variables": { "error": "", "decorators": [ { "type": "encryption", "pointer": "/mkbHr3ZJ" } ] }, "deprecated": true, "scheduled": false, "matched": [ { "key": "id aliqua Ut deserunt cillum", "highlightString": "laboris dolore Duis" }, { "key": "ex", "highlightString": "dolore mollit" } ], "status": "running", "previous": { "incomplete": [ "error_handler", "error_handler" ], "complete": [ "workflow_end", "error_handler", "workflow_end", "workflow_start", "3a1f" ], "error": [ "workflow_start", "workflow_end", "workflow_start" ] }, "taskId": "workflow_end", "transitions": { "success": [ { "task": "workflow_start", "type": "standard" } ], "failure": [ { "task": "workflow_start", "type": "standard" } ], "error": [ { "task": "workflow_start", "type": "loop" }, { "task": "error_handler", "type": "revert" }, { "task": "3a1f", "type": "revert" } ] }, "serverId": "dolore tempor enim commodo nulla", "start_time": "1976-11-22T16:52:06.068Z", "end_time": 59470121.31669611, "finish_state": "success", "retrySettings": { "state": [ "error", "error", "success", "success" ], "autoRetry": true, "limit": 73493994, "delay": 86517393, "count": 88594968, "finishedRetrying": true }, "type": "manual", "view": "exercitation veniam" }, "workflow_start": { "x": 65836473.5019494, "y": -81397857.37763412, "gridCoordinate": { "x": 87581668.51724744, "y": -53718014.17762976 }, "name": "workflow_start", "summary": "workflow_start", "taskId": "workflow_start", "metrics": { "start_time": -17102152.63236177, "finish_state": "error", "user": "08ac224198f75590c2ae9975" }, "groups": [ "27ad6e8f49fad00b7903606c", "7312374fd827e20733d18608", "4ae0a5142422459b5723dc29", "ae99431e8258127690b346af", { "_id": "5662869824158000b0410ddf", "provenance": "quis", "name": "laboris dolore", "description": "non ut sunt enim", "memberOf": [ { "groupId": "302bbea3314b90085c0e0264", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "labore anim et" }, { "roleId": "pariatur in qui incididunt" }, { "roleId": "pariatur consequat ipsum veniam cupidatat" } ], "inactive": true, "_meta": { "created": "1983-02-26T19:37:10.204Z", "updated": "1968-10-30T00:47:15.774Z", "migrationVersion": -31701555 } } ], "iterations": [ "CA7149dA-440B-CAFB-AD5a-d7A1BDE83b8B" ] }, "workflow_end": { "x": 90702971.13019353, "y": -1784345.7337739766, "gridCoordinate": { "x": -63441738.10930438, "y": 20770617.424625963 }, "name": "workflow_end", "summary": "workflow_end", "taskId": "workflow_end", "endTasks": { "incomplete": [ "workflow_end", "workflow_start", "3a1f", "workflow_end" ], "complete": [ "workflow_end", "3a1f", "3a1f" ], "error": [ "workflow_start" ] }, "metrics": { "end_time": -12974217.832349315, "run_time": -63883071.93220655 }, "groups": [ "e3a5edda1676d9b333b1e2fa", { "_id": "a451803e4759efe5f5331294", "provenance": "exercitation enim fugiat consectetur sed", "name": "culpa eu", "description": "id do et dolor cupidatat", "memberOf": [ { "groupId": "e8de3b650eb3544ea61c1f0c", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "consectetur occaecat eu enim pariatur" }, { "roleId": "deserunt aliquip reprehenderit consectetur sint" } ], "inactive": true, "_meta": { "created": "1999-07-29T06:39:23.923Z", "updated": "2011-03-19T19:32:39.577Z", "migrationVersion": 30712267 } }, "default" ], "iterations": [ "cBf0D100-a0eC-01Bd-aE30-Ae68a0c21860" ] }, "error_handler": { "x": -13139482.749751478, "y": 17407118.73685305, "gridCoordinate": { "x": 5377542.9097628, "y": 9389114.599605545 }, "name": "childJob", "location": "Adapter", "locationType": null, "app": "non sed", "canvasName": "mollit quis ipsum fugiat", "displayName": "elit sunt anim", "summary": "cillum deserunt", "description": "anim enim deserunt mollit tempor", "variables": { "error": "", "decorators": [ { "type": "encryption", "pointer": "/~1/J/jRrlvXce+,/e7DzKsLRl/xxio,z6/c5lC-ImODB/~1/~0/DFrFGlta6/~1/da7nXl" }, { "type": "encryption", "pointer": "/d8/~1/iW4C9TF4w/~1/~1/J2,/4/~0/iR+a20" }, { "type": "encryption", "pointer": "/~1/~0/~0/~0/~0/fNu+/KvMQKa" }, { "type": "encryption", "pointer": "/~1/XskZfwO/MZ7x3.X7P/KdCOKhZ0/~1" }, { "type": "encryption", "pointer": "/miXDV/FesM/~1/hv/t.Jnb/~1/~1/~0/~1/QuN/~0/~1" } ] }, "deprecated": false, "scheduled": true, "matched": [ { "key": "irure commodo", "highlightString": "exercitation ut aliqua ex" } ], "status": "complete", "previous": { "incomplete": [ "workflow_start" ], "complete": [ "e28f", "workflow_start" ], "error": [ "3a1f", "e28f", "workflow_end", "e28f", "error_handler" ] }, "taskId": "workflow_start", "transitions": { "success": [ { "task": "workflow_start", "type": "revert" }, { "task": "error_handler", "type": "loop" }, { "task": "error_handler", "type": "loop" } ], "failure": [ { "task": "3a1f", "type": "loop" } ], "error": [ { "task": "e28f", "type": "loop" }, { "task": "workflow_start", "type": "revert" } ] }, "serverId": "anim sit", "start_time": "1953-02-21T19:13:44.225Z", "end_time": -97377148.06781317, "finish_state": "success", "retrySettings": { "state": [ "success", "failure" ], "autoRetry": false, "limit": 56968524, "delay": 30501934, "count": 57640020, "finishedRetrying": true }, "type": "operation", "actor": "job", "groups": [ { "_id": "5665c22da02e705664dbd87e", "provenance": "dolore", "name": "Excepteur ea ut", "description": "dolor dolore deserunt cupidatat", "memberOf": [ { "groupId": "5442e119d719d82ca7825e10", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "voluptate" }, { "roleId": "qui adipisicing" }, { "roleId": "nostrud do" } ], "inactive": false, "_meta": { "created": "1985-06-17T18:41:28.618Z", "updated": "1988-05-27T00:34:28.025Z", "migrationVersion": 40940983 } } ], "iterations": [] } }, "parent": { "job": "laboris dolor sed", "task": "tempor ea Lorem aute magna", "iteration": 25806747.0402731, "element": -43445435.899705306 }, "errorHandler": null, "groups": [ "default", "default" ], "watchers": [ { "_id": "b8d60ee3b69f53fc5d7bf510", "provenance": "eu reprehenderit enim do", "username": "amet in officia esse", "firstname": "exercitation commodo", "memberOf": [ { "groupId": "ec31cbbec846e059e3a45db9", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "enim mollit" }, { "roleId": "commodo ex aliqua eu" } ], "inactive": false, "lastLogin": "1976-02-08T10:44:08.995Z", "_meta": { "created": "2013-06-21T23:22:19.581Z", "updated": "2005-12-08T17:45:11.513Z", "migrationVersion": -28194040 }, "email": "magna velit" }, { "_id": "c30ee9e7478796bdfa9a4253", "provenance": "irure cillum sed sint", "username": "sunt exercitation cupidatat", "firstname": "magna quis ea", "memberOf": [ { "groupId": "53c6a84c0c1a960dbd0e5db8", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "est occaecat proident Excepteur" }, { "roleId": "dolor ea laboris nisi aliquip" } ], "inactive": true, "lastLogin": "1950-03-07T03:36:00.76Z", "_meta": { "created": "1950-11-20T06:12:18.852Z", "updated": "2014-03-16T22:28:58.385Z", "migrationVersion": -7023388 }, "email": "eu laboris fugiat esse in" } ], "metrics": { "start_time": -17959478.83042021, "progress": 0.6194624277417247, "end_time": -72870663.81546618, "user": "bcf60479e59deccaa1a40b6b", "owner": null } } }
{ "title": "job", "allOf": [ { "$ref": "common-api#/definitions/success-response" }, { "type": "object", "properties": { "data": { "$ref": "job-api" } } } ] }