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": "anim est velit", "options": { "description": "Example job description", "type": "automation", "groups": [ "da23d9115cbc466bc5010486" ] } }
{ "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 imported 3 of 4 documents", "data": { "_id": "540b199f933cd4799f28aa32", "font_size": 88940466, "type": "resource:compliance", "created": "2011-01-23T23:54:15.672Z", "last_updated": "1994-07-29T12:34:30.9Z", "createdVersion": "60394831675.9.4", "lastUpdatedVersion": "045208.421.4755342641", "canvasVersion": 2, "encodingVersion": 1, "migrationVersion": 66139775, "name": "myCoolDocumentName", "description": null, "preAutomationTime": 88343600.83606055, "sla": -5892002.326224282, "decorators": [ { "type": "encryption", "pointer": "/~0/~1/kQXSi/~1" } ], "status": "running", "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": "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": "workflow_start", "name": "myCoolDocumentName", "message": "voluptate proident id cillum Ut" }, { "task": "e28f", "name": "myCoolDocumentName" }, { "task": "3a1f", "name": "myCoolDocumentName", "message": "mollit aliqua dolor" } ], "ancestors": null, "validationErrors": [ { "keyword": "cillum", "instancePath": "nostrud est reprehenderit voluptate ut", "schemaPath": "elit nostrud", "message": "et eu" }, { "keyword": "occaecat ullamco deserunt dolore irure", "instancePath": "fugiat", "schemaPath": "adipisicing minim laboris nulla", "message": "laborum aute" }, { "keyword": "reprehenderit esse", "instancePath": "do minim", "schemaPath": "sint minim adipisicing anim", "message": "aliquip ea velit" } ], "created_by": null, "last_updated_by": "6017032916af01206dc99791", "tasks": { "4781": { "actor": "5b05cb64a29d392bcd4e1f60", "groups": [ "1d15359ecc6ff358d139d2e1" ], "iterations": [ "Cf44FD4A-De1d-8CFe-DDDf-BaDa5299Cf32", "52a2edaE-46fF-021a-6AFF-3FDf2F5Bf3EB" ], "x": -25580631.80756092, "y": 21936171.96134308, "gridCoordinate": { "x": -30533958.88919717, "y": -35859980.929540925 }, "name": "qui minim ipsum aliqua", "location": "Adapter", "locationType": null, "app": "sunt", "canvasName": "childJob", "displayName": "sunt", "summary": "ipsum", "description": "aute", "variables": { "error": "", "decorators": [ { "type": "encryption", "pointer": "/~0/~1/Wh/~1/FlrikhEr/nzC/IIgS8Z8/~0/~1" } ] }, "deprecated": false, "scheduled": true, "matched": [ { "key": "fugiat officia", "highlightString": "adipisicing sint incididunt" } ], "status": "error", "previous": { "incomplete": [ "e28f", "workflow_start" ], "complete": [ "workflow_end", "workflow_start", "error_handler", "workflow_start" ], "error": [ "workflow_start" ] }, "taskId": "workflow_start", "transitions": { "success": [ { "task": "workflow_start", "type": "revert" }, { "task": "error_handler", "type": "standard" }, { "task": "workflow_start", "type": "standard" }, { "task": "workflow_end", "type": "standard" } ], "failure": [ { "task": "workflow_start", "type": "standard" } ], "error": [ { "task": "workflow_end", "type": "loop" }, { "task": "workflow_start", "type": "revert" }, { "task": "error_handler", "type": "standard" } ] }, "serverId": "enim incididunt", "start_time": "1953-12-12T11:12:32.615Z", "end_time": 95003302.22303149, "finish_state": "failure", "retrySettings": null, "loop": { "atLeastOneComplete": true, "finishedCount": 64910598.96635577, "outgoing": [ "sed adipisicing eiusmod", "et" ] }, "childJobs": [ { "_id": "ipsum", "name": "dolor aliquip velit", "iteration": 32438116.326684475 }, { "_id": "enim consequat sed do occaecat", "name": "amet", "iteration": -6752861.465468392 }, { "_id": "elit in Duis aute irure", "name": "sed", "iteration": -51920967.37907139 }, { "_id": "mollit proident aute pariatur ipsum", "name": "pariatur irure dolore sint eu", "iteration": -79398348.09309411 }, { "_id": "occaecat nostrud consectetur", "name": "occaecat dolor cillum", "iteration": -77599352.49151084 } ] }, "workflow_start": { "x": -2715667.3384200633, "y": -5730773.241713032, "gridCoordinate": { "x": -87485827.01410057, "y": 37205885.324997544 }, "name": "workflow_start", "summary": "workflow_start", "taskId": "workflow_start", "metrics": { "start_time": 80283267.11291555, "finish_state": "error", "user": "f726a50dacd85827029e599b" }, "groups": [ { "_id": "21570137aa58eb71ea08de6e", "provenance": "sed", "name": "nisi id", "description": "deserunt proident officia voluptate ipsum", "memberOf": [ { "groupId": "99f951a78f7a30c6fc6af7b5", "aaaManaged": false }, { "groupId": "11bcb5f84dcb44725807e055", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "nulla magna cupidatat laborum consequat" }, { "roleId": "in laborum" }, { "roleId": "consectetur" }, { "roleId": "incididunt sunt sint minim ea" }, { "roleId": "anim ut qui irure Excepteur" } ], "inactive": true, "_meta": { "created": "2001-02-07T10:14:18.196Z", "updated": "1976-03-02T03:20:06.585Z", "migrationVersion": 38150797 } }, "default" ], "iterations": [] }, "workflow_end": { "x": -38841191.866924785, "y": -69693994.20884553, "gridCoordinate": { "x": -44922866.51978143, "y": -92205284.46207741 }, "name": "workflow_end", "summary": "workflow_end", "taskId": "workflow_end", "endTasks": { "incomplete": [ "3a1f" ], "complete": [ "error_handler", "3a1f", "workflow_end" ], "error": [ "workflow_end" ] }, "metrics": { "end_time": 48660067.242445946, "run_time": 77853637.6432578 }, "groups": [ { "_id": "53cfb08a0d1e7eeb6a476301", "provenance": "qui do eiusmod dolor", "name": "irure officia", "description": "do dolor aliquip", "memberOf": [ { "groupId": "7211446313826ec4b3ee0661", "aaaManaged": false }, { "groupId": "4021b8649066cc1d3c47b897", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "ea incididunt magna" }, { "roleId": "fugiat irure" } ], "inactive": true, "_meta": { "created": "1986-03-16T10:03:05.576Z", "updated": "1979-09-10T01:21:05.158Z", "migrationVersion": 4082213 } }, "default", { "_id": "6da9c4b08393130937309fa0", "provenance": "esse", "name": "magna", "description": "enim commodo sint aliquip", "memberOf": [ { "groupId": "7cb1497b695dc7244b541a98", "aaaManaged": false }, { "groupId": "a2417430c2c11555c98476eb", "aaaManaged": false }, { "groupId": "251900eb5df53dcf9eaf655f", "aaaManaged": true }, { "groupId": "4ea3c5a4cded80bd0e563127", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "fugiat ipsum non in pariatur" }, { "roleId": "proident veniam eiusmod in consectetur" }, { "roleId": "incididunt laboris ut ea" }, { "roleId": "deserunt" } ], "inactive": true, "_meta": { "created": "1953-11-15T21:39:13.693Z", "updated": "1997-08-23T17:03:01.81Z", "migrationVersion": 41487545 } } ], "iterations": [ "E5c04EcE-70B0-0FfF-1e51-355FBA01D8A0" ] }, "error_handler": { "x": 35848203.54557237, "y": 28692001.46822086, "gridCoordinate": { "x": 28387296.730405703, "y": -22620713.080977812 }, "name": "childJob", "location": "Application", "locationType": "consectetur dolor", "app": "non quis Excepteur", "canvasName": "pariatur nisi in", "displayName": "mollit exercitation adipisicing commodo", "summary": "ut eiusmod consectetur irure", "description": "in occaecat elit proident deserunt", "variables": { "error": "", "decorators": [ { "type": "encryption", "pointer": "/~0/c/~1/PZDGuyI+U/fq9DqL/yn6JIuATHYu" } ] }, "deprecated": false, "scheduled": true, "matched": [ { "key": "quis", "highlightString": "sunt et do proident tempor" }, { "key": "non reprehenderit aliqua", "highlightString": "dolore adipisicing labore consectetur aliquip" }, { "key": "cupidatat minim aute occaecat", "highlightString": "culpa adipisicing aute exercitation" } ], "status": "canceled", "previous": { "incomplete": [ "error_handler", "3a1f", "workflow_start" ], "complete": [ "3a1f", "3a1f", "workflow_start", "error_handler" ], "error": [ "3a1f" ] }, "taskId": "workflow_start", "transitions": { "success": [ { "task": "workflow_start", "type": "loop" }, { "task": "3a1f", "type": "revert" }, { "task": "3a1f", "type": "loop" }, { "task": "e28f", "type": "loop" } ], "failure": [ { "task": "e28f", "type": "revert" } ], "error": [ { "task": "workflow_end", "type": "standard" }, { "task": "workflow_start", "type": "revert" } ] }, "serverId": "velit", "start_time": "2014-03-25T15:49:04.368Z", "end_time": -41606136.75595979, "finish_state": "error", "retrySettings": { "state": [ "error", "success", "failure" ], "autoRetry": true, "limit": 54913710, "delay": 54216551, "count": 45121605, "finishedRetrying": true }, "type": "operation", "actor": "Pronghorn", "groups": [ "d211eb20dd26642d6fd0b7ea", "fe6def2b097471267d515398", { "_id": "e4fa3cf077302548c8ac50a6", "provenance": "elit nisi in pariatur ut", "name": "laborum", "description": "occaecat", "memberOf": [ { "groupId": "eebcf281010f37507b32aa04", "aaaManaged": false }, { "groupId": "145516efe1bcdc5233e71e2e", "aaaManaged": false }, { "groupId": "132e5c426152bef952ba1ec9", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "magna nisi anim adipisicing" }, { "roleId": "reprehenderit Duis est cupidatat velit" } ], "inactive": true, "_meta": { "created": "1960-03-06T14:32:07.756Z", "updated": "1985-01-10T15:24:50.588Z", "migrationVersion": -62611735 } }, "a996de455be58a4fa7a7b278" ], "iterations": [] } }, "parent": { "job": "ipsum veniam do consequat", "task": "esse", "iteration": -79248968.68048874, "element": -28762647.16860448 }, "errorHandler": null, "groups": [ "b5c1f88c3c64f35df1003adc", "default", "080f21589888c835f9f72722", { "_id": "498aafc31730d983fc2d90c8", "provenance": "in", "name": "qui eiusmod", "description": "ex Excepteur non id qui", "memberOf": [ { "groupId": "ebc642c73008fcf9a1684252", "aaaManaged": false }, { "groupId": "ae30c019f81bceb3b8ee3544", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "aliquip ex eiusmod sed occaecat" }, { "roleId": "non quis sunt" }, { "roleId": "sed adipisicing eu" } ], "inactive": false, "_meta": { "created": "2022-03-22T16:44:09.997Z", "updated": "1979-03-26T13:05:13.811Z", "migrationVersion": 83655200 } } ], "watchers": [ null, { "_id": "d11e9c0dd1218fcc0d594cd0", "provenance": "culpa laboris ut", "username": "ea consectetur elit exercitation", "firstname": "magna sunt fugiat est", "memberOf": [ { "groupId": "1e99d7380c11b2f0d1d9f323", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "veniam magna nulla anim" }, { "roleId": "cillum" }, { "roleId": "sunt" }, { "roleId": "culpa cillum nostrud adipisicing anim" } ], "inactive": true, "lastLogin": "1975-07-04T16:53:36.307Z", "_meta": { "created": "1966-04-03T13:08:02.648Z", "updated": "1947-08-31T08:08:49.829Z", "migrationVersion": -595147 }, "email": "irure" } ], "metrics": { "start_time": -47078232.777631566, "progress": 0.8381771074954887, "end_time": 98103384.0175677, "user": null, "owner": "582d77c6188689ee697420f3" } } }
{ "title": "job", "allOf": [ { "$ref": "common-api#/definitions/success-response" }, { "type": "object", "properties": { "data": { "$ref": "job-api" } } } ] }