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": "cupidatat", "options": { "description": "Example job description", "type": "automation", "groups": [ "e509132f3cf5d30456c31a42", "23b496d4a5225db1bc0c72d9" ] } }
{ "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 retrieved search results", "data": { "_id": "8dd5cf99f43ffb31ff626e9f", "font_size": 19900150, "type": "resource:action", "created": "1988-04-05T02:39:02.563Z", "last_updated": "2003-01-24T17:32:06.806Z", "createdVersion": "667120.35421.8161205", "lastUpdatedVersion": "3.507.0612", "canvasVersion": 2, "encodingVersion": 1, "migrationVersion": 10596102, "name": "myCoolDocumentName", "description": "Some helpful information about the document", "preAutomationTime": -23860395.350645363, "sla": -16351728.00419724, "decorators": [ { "type": "encryption", "pointer": "/~0/iJocQ/~0/mQUX/IVh" }, { "type": "encryption", "pointer": "/~0/ApSjRXR/~1/~0/eihCm,CyGqL/CTgp2n/UKzVCwyGLVv/EC/~1" } ], "status": "incomplete", "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 }, { "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": "error_handler", "name": "myCoolDocumentName" }, { "task": "workflow_start", "name": "myCoolDocumentName", "message": "proident in dolor" }, { "task": "workflow_start", "name": "myCoolDocumentName" }, { "task": "3a1f", "name": "myCoolDocumentName", "message": "do consequat" } ], "ancestors": null, "validationErrors": [ { "keyword": "incididunt veniam do tempor", "dataPath": "dolor elit cupidatat aliqua ut", "schemaPath": "nisi do Duis laborum", "message": "amet culpa veniam" } ], "created_by": "Pronghorn", "last_updated_by": null, "tasks": { "0": { "actor": "job", "groups": [ "default", { "_id": "a07985bb1bec62472ca5f735", "provenance": "ipsum proident dolor", "name": "ut in quis officia sit", "description": "incididunt Ut", "memberOf": [ { "groupId": "d13350bc4b492a021754577b", "aaaManaged": false }, { "groupId": "dc60fa6ccf6e3195a29f8d60", "aaaManaged": false }, { "groupId": "2d0d03878df6ce6b79c6b947", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "proident eiusmod" } ], "inactive": false, "_meta": { "created": "1991-04-28T21:41:09.21Z", "updated": "1961-03-12T20:10:54.731Z", "migrationVersion": -68134314 } } ], "iterations": [ "0bFdad2F-6BFd-E68E-Db7C-BFdF1fC2032b" ], "x": 48074979.05670738, "y": -13957600.094345361, "gridCoordinate": { "x": 79468163.52952334, "y": -64660316.65813552 }, "name": "officia id fugiat sint dolor", "location": "Adapter", "locationType": "est", "app": "tempor exercitation cupidatat Ut aliquip", "canvasName": "childJob", "displayName": "mollit velit nisi", "summary": "enim et amet ut", "description": "irure occaecat ex laboris", "variables": { "error": "", "decorators": [ { "type": "encryption", "pointer": "/~1/~1/nC/~0/N/~0/k81quwP/Mt/fgJU" }, { "type": "encryption", "pointer": "/AnNx5BCDkSI/~1/~0/wj/~1/l0AnX/Qu9FmF23/~1" }, { "type": "encryption", "pointer": "/~1/iy+Xu,pf/z61DD/m5K/Ln/4ssDe" }, { "type": "encryption", "pointer": "/L9/fDC+/B5/gu9k1" }, { "type": "encryption", "pointer": "/O/~0/W36td5e9I/~0/p98aG4rCs,m" } ] }, "deprecated": true, "scheduled": true, "matched": [ { "key": "in", "highlightString": "irure non quis ipsum" }, { "key": "sunt Excepteur Duis", "highlightString": "cupidatat" }, { "key": "sed adipisicing minim est dolore", "highlightString": "nostrud est" }, { "key": "occaecat Excepteur", "highlightString": "et dolore cupidatat" } ], "status": "incomplete", "previous": { "incomplete": [ "workflow_start", "3a1f", "e28f" ], "complete": [ "error_handler", "error_handler", "error_handler", "workflow_end", "workflow_end" ], "error": [ "workflow_start", "error_handler" ] }, "taskId": "workflow_start", "transitions": { "success": [ { "task": "workflow_end", "type": "revert" }, { "task": "workflow_end", "type": "standard" }, { "task": "workflow_start", "type": "loop" } ], "failure": [ { "task": "e28f", "type": "standard" }, { "task": "workflow_end", "type": "standard" }, { "task": "e28f", "type": "standard" }, { "task": "3a1f", "type": "standard" } ], "error": [ { "task": "e28f", "type": "loop" }, { "task": "workflow_start", "type": "standard" } ] }, "serverId": "elit consequat", "start_time": "2005-04-12T06:26:40.145Z", "end_time": -14228378.197988749, "finish_state": "failure", "retrySettings": null, "loop": { "atLeastOneComplete": false, "finishedCount": -31234117.875653133, "outgoing": [ "nulla", "ut cupidatat est fugiat" ] }, "childJobs": [ { "_id": "non cillum id", "name": "officia consequat Excepteur", "iteration": 22254776.00379105 } ] }, "workflow_start": { "x": -14293505.971654147, "y": -98285054.61766696, "gridCoordinate": { "x": 62248944.42609084, "y": 24920821.152530164 }, "name": "workflow_start", "summary": "workflow_start", "taskId": "workflow_start", "metrics": { "start_time": -47400720.5960167, "finish_state": "error", "user": { "_id": "f49065a5e15d45d97157b004", "provenance": "culpa minim consequat dolor", "username": "ex adipisicing laboris eu", "firstname": "culpa", "memberOf": [ { "groupId": "5ff5268c6ea7dd7dce528a91", "aaaManaged": true }, { "groupId": "a647573acebdf5d2fd05c11c", "aaaManaged": true }, { "groupId": "e74e760587009eee0e4b97ef", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "est id laborum occaecat" }, { "roleId": "cillum consectetur voluptate" }, { "roleId": "do mollit consectetur" }, { "roleId": "ut veniam" } ], "inactive": false, "lastLogin": "1971-01-15T07:28:09.349Z", "_meta": { "created": "1962-04-18T11:38:58.331Z", "updated": "1979-12-09T06:19:26.47Z", "migrationVersion": -86942215 }, "email": "non consectetur quis Ut labore" } }, "groups": [ "2b6ac210531a6496e7ae774f", "default" ], "iterations": [ "6DCD4e33-f66e-f77F-eDbC-B5eC2BD7d8Bc", "83Dd7E51-EA79-cAAf-Cd20-d11F04faf0bc", "889FdC1d-AeeF-b3Cf-bBB8-2d9bdFdEfc3A" ] }, "workflow_end": { "x": -75775179.5625746, "y": 57977232.04815212, "gridCoordinate": { "x": 68461457.40044302, "y": -48941510.851047054 }, "name": "workflow_end", "summary": "workflow_end", "taskId": "workflow_end", "endTasks": { "incomplete": [ "workflow_start", "e28f", "workflow_start", "e28f", "error_handler" ], "complete": [ "e28f" ], "error": [ "workflow_end", "e28f", "workflow_start", "3a1f", "error_handler" ] }, "metrics": { "end_time": -18861472.385990024, "run_time": -848610.5561733097 }, "groups": [ "default", { "_id": "b0b94b62eb72eef084bb58b5", "provenance": "officia nostrud exercitation nulla laboris", "name": "aute minim do", "description": "ipsum elit in velit amet", "memberOf": [ { "groupId": "36114db11e93a89c97f98d7f", "aaaManaged": true }, { "groupId": "3530ced67a825d69bead31be", "aaaManaged": true }, { "groupId": "20534aefb11506d025f2fbd5", "aaaManaged": true }, { "groupId": "c5c458f6e7e85ad994b9370b", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "tempor qui ad in" }, { "roleId": "laborum" }, { "roleId": "sint" }, { "roleId": "cillum exercitation Duis" }, { "roleId": "laborum ea sint" } ], "inactive": false, "_meta": { "created": "2002-12-30T00:24:45.645Z", "updated": "2022-06-29T22:36:28.271Z", "migrationVersion": 10226255 } } ], "iterations": [ "9FECADF0-FeD7-D6Cf-6Fcb-Be3B327cC398", "Fa6f3A2C-14dA-3aDD-e4B6-dF6E23AE1c1c" ] }, "error_handler": { "x": -75178112.54622853, "y": -16284624.79045321, "gridCoordinate": { "x": -64783770.71963695, "y": 92295152.53964499 }, "name": "childJob", "location": "Application", "locationType": null, "app": "nostrud Excepteur", "canvasName": "tempor", "displayName": "cupidatat non labore dolor", "summary": "Lorem do eiusmod", "description": "adipisicing ex minim mollit", "variables": { "error": "", "decorators": [ { "type": "encryption", "pointer": "/~1/rQ5TQ6Mv0X/~0/xn8giyQf/~0/J5WOh" } ] }, "deprecated": false, "scheduled": true, "matched": [ { "key": "proident", "highlightString": "magna Duis enim" } ], "status": "error", "previous": { "incomplete": [ "workflow_end", "workflow_start" ], "complete": [ "e28f" ], "error": [ "error_handler" ] }, "taskId": "workflow_start", "transitions": { "success": [ { "task": "workflow_end", "type": "standard" }, { "task": "e28f", "type": "loop" } ], "failure": [ { "task": "workflow_start", "type": "standard" }, { "task": "workflow_end", "type": "loop" }, { "task": "e28f", "type": "loop" } ], "error": [ { "task": "3a1f", "type": "loop" }, { "task": "workflow_start", "type": "loop" }, { "task": "workflow_start", "type": "revert" }, { "task": "workflow_end", "type": "revert" }, { "task": "workflow_start", "type": "standard" } ] }, "serverId": "dolore", "start_time": "2021-05-19T23:27:07.421Z", "end_time": 73707155.89343387, "finish_state": "failure", "retrySettings": { "state": [ "error", "error" ], "autoRetry": false, "limit": 94323260, "delay": 35938233, "count": 35756791, "finishedRetrying": false }, "type": "operation", "actor": { "_id": "0988a81e81b162e3c553362f", "provenance": "magna elit est", "username": "cillum laboris", "firstname": "enim ea consectetur cupidatat fugiat", "memberOf": [ { "groupId": "c6809ebb30671b600d542f59", "aaaManaged": true }, { "groupId": "eba7248f8488c05f1bfe1b0d", "aaaManaged": true }, { "groupId": "a4a87ec77b40db09843364c8", "aaaManaged": true }, { "groupId": "d4c8a11592efdcc87ef4d9cc", "aaaManaged": false }, { "groupId": "d4ff1a9aa0cfb52b9df4b8ee", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "reprehenderit" }, { "roleId": "ad qui cillum anim dolor" } ], "inactive": true, "lastLogin": "2017-01-10T01:28:35.772Z", "_meta": { "created": "2021-07-19T11:40:34.047Z", "updated": "1969-04-13T11:51:52.269Z", "migrationVersion": 90754911 }, "email": "dolore cillum" }, "groups": [ "default", "ce79a2013031816e4c2604a3" ], "iterations": [ "1c44dAD0-Fcc7-EFE4-D6d3-aFC417D0afdc", "BAc2A1Aa-F481-f454-C78B-c6a3df79d3A7" ] } }, "parent": { "task": "ad quis consequat consectetur", "iteration": 9429207.919006228, "element": -18731205.515533134 }, "errorHandler": { "actor": "job", "groups": [ "225335930f783190839ceb5c" ], "iterations": [ "7cBB62Dc-80D6-EAe2-f1f5-Bc491FC1CB2E", "6E1Ccec4-2660-bCbA-CeeD-696F2f5329d2", "D98e5Ab5-Df6E-870e-d8D5-503556da40D4" ], "x": 73946417.08657482, "y": 96544656.85891497, "gridCoordinate": { "x": -53221660.161113605, "y": -47220108.60860077 }, "name": "Duis ad nulla cupidatat", "location": "Application", "locationType": "in voluptate", "app": "in in", "canvasName": "childJob", "displayName": "mollit in", "summary": "ipsum dolore", "description": "eu", "variables": { "error": "", "decorators": [ { "type": "encryption", "pointer": "/h8fG/,GePbk/FF.Joj1nvIq/M/~0/vwY3+3HEj3/~0/~0/~1" } ] }, "deprecated": false, "scheduled": false, "matched": [ { "key": "ullamco Excepteur dolor qui deserunt", "highlightString": "ad ex" } ], "status": "scheduled", "previous": { "incomplete": [ "e28f" ], "complete": [ "3a1f", "workflow_start", "e28f" ], "error": [ "workflow_end", "3a1f", "workflow_start" ] }, "taskId": "workflow_start", "transitions": { "success": [ { "task": "error_handler", "type": "loop" }, { "task": "workflow_start", "type": "standard" }, { "task": "3a1f", "type": "loop" } ], "failure": [ { "task": "workflow_start", "type": "revert" }, { "task": "e28f", "type": "standard" } ], "error": [ { "task": "3a1f", "type": "revert" } ] }, "serverId": "ea", "start_time": "1972-04-11T10:14:49.31Z", "end_time": 71443478.58254948, "finish_state": "success", "retrySettings": null, "loop": { "atLeastOneComplete": true, "finishedCount": -69590082.79097772, "outgoing": [ null ] }, "childJobs": [ { "_id": "ullamco", "name": "dolore do non enim elit", "iteration": -14900476.029009461 }, { "_id": "consectetur sint amet Lorem dolore", "name": "eiusmod reprehenderit dolore", "iteration": 94842664.81198102 } ] }, "groups": [ "default", "default", "3dd61ec71d1bbccef99e84d5", "default" ], "watchers": [ "Pronghorn" ], "metrics": { "start_time": 7924612.736899927, "progress": 0.8063004012367472, "end_time": 65968121.96075365, "user": "Pronghorn", "owner": "Pronghorn" } } }
{ "title": "job", "allOf": [ { "$ref": "common-api#/definitions/success-response" }, { "type": "object", "properties": { "data": { "$ref": "job-api" } } } ] }