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": "laborum tempor velit mollit aute", "options": { "description": "Example job description", "type": "automation", "groups": [ "d7d010d4f3209ca6b0814826", "23dbd2beaae119e0bd2ef89d", "0fa238eec15d74e603678e3e", "a3c6248d0fab263ae599d599", "3e36a9d05bafecc37b9a5607" ] } }
{ "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": "8ea9be0179c0551d1697cbcc", "font_size": 81330945, "type": "automation", "created": "1968-08-24T18:33:17.006Z", "last_updated": "2019-09-03T00:28:28.418Z", "createdVersion": "18601412285.2722168.496", "lastUpdatedVersion": "8.57420545586.23128-7105.53.12", "canvasVersion": 1.5, "encodingVersion": 1, "migrationVersion": 52907622, "name": "myCoolDocumentName", "description": "Some helpful information about the document", "preAutomationTime": 87247947.37428129, "sla": 8905874.452732518, "decorators": [ { "type": "encryption", "pointer": "/TG1/~1/Sm/eLyqBd.5v/~1" }, { "type": "encryption", "pointer": "/ZmXsaLa/~1/op.dGJxOxwe" }, { "type": "encryption", "pointer": "/~1/MOd3IE3RZ/~0/~1/~0" }, { "type": "encryption", "pointer": "/~1/g8MsKJ07/~0/~0/~1/~0/s3/OI/~0/~1/~1" }, { "type": "encryption", "pointer": "/t,0ee/kgAI+pZ1U/~1/~1/~0/Wl5172bc/~0/~0/RovF8q" } ], "status": "canceled", "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": "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 } ], "warnings": [ { "task": "error_handler", "name": "myCoolDocumentName", "message": "laborum minim officia eiusmod" }, { "task": "error_handler", "name": "myCoolDocumentName", "message": "ipsum dolor enim voluptate" }, { "task": "workflow_start", "name": "myCoolDocumentName" } ], "ancestors": [ "d4d6f8d819aa47eed811c7bc", "4ed1c447765f6e096f3b9e97", "13f205efcf1431fe6d14539a", "5bf1f8b3d6d3a01fba19c265", "73c6e75a6ccf4fd0c2874fe9" ], "validationErrors": [ { "keyword": "irure occaecat", "dataPath": "eiusmod adipisicing cillum", "schemaPath": "sunt aliqua laborum", "message": "proident exercitation ut eu" }, { "keyword": "non laboris Ut dolore amet", "dataPath": "culpa exercitation magna", "schemaPath": "Excepteur culpa laborum", "message": "incididunt" }, { "keyword": "adipisicing aliquip nisi", "dataPath": "occaecat dolore eu", "schemaPath": "ea eiusmod in", "message": "nisi dolor elit ullamco ad" }, { "keyword": "voluptate minim tempor", "dataPath": "nostrud consectetur non", "schemaPath": "aliquip sint aliqua", "message": "aliqua incididunt ad" }, { "keyword": "non", "dataPath": "irure sed laborum", "schemaPath": "ipsum in proident ut", "message": "culpa quis exercitation" } ], "created_by": null, "last_updated_by": null, "tasks": { "workflow_start": { "x": 59690823.75819862, "y": -95645913.33641346, "gridCoordinate": { "x": 94978744.06275693, "y": 79669554.82416397 }, "name": "workflow_start", "summary": "workflow_start", "taskId": "workflow_start", "metrics": { "start_time": -74065961.93113129, "finish_state": "success", "user": "a0be83547fe01fb7e7009d37" }, "groups": [ "9cbac8b04c4f2d56bd4b056b", "c7b5b63b475636bbc7be1543" ], "iterations": [ "9b3b2A4e-7Cdb-Fa2A-cE3d-603e3ddaEBAB" ] }, "workflow_end": { "x": 85320771.17020282, "y": -62704568.69061216, "gridCoordinate": { "x": 25055965.873456463, "y": -62799133.728457205 }, "name": "workflow_end", "summary": "workflow_end", "taskId": "workflow_end", "endTasks": { "incomplete": [ "3a1f", "e28f" ], "complete": [ "3a1f", "workflow_start" ], "error": [ "error_handler" ] }, "metrics": { "end_time": 88670204.88119772, "run_time": -5448840.116576508 }, "groups": [ "default", "f26b7ed92c396f8c5352f53f" ], "iterations": [ "BCeEED74-29C7-21d3-c16a-bDC0F3CD75eb" ] }, "error_handler": { "x": -78197701.10917252, "y": 14130796.108151868, "gridCoordinate": { "x": -78534840.4126498, "y": 57185640.80295271 }, "name": "childJob", "location": "Adapter", "locationType": null, "app": "cillum nostrud officia mollit cupidatat", "canvasName": "in", "displayName": "deserunt aute velit et", "summary": "esse laboris nisi pariatur", "description": "occaecat", "variables": { "error": "", "decorators": [ { "type": "encryption", "pointer": "/~1/S6PKn13xR/" }, { "type": "encryption", "pointer": "/GOZrJyBVja/~1/Hq/~0/~1/M9AW/C7KLX2ORBKy/O9Hsx+os9a/~1/~1" }, { "type": "encryption", "pointer": "/CyrvRLG4/PG5q336DY7/~1/~0" }, { "type": "encryption", "pointer": "/~1" } ] }, "deprecated": true, "scheduled": false, "matched": [ { "key": "dolore voluptate consectetur magna", "highlightString": "commodo amet dolor Duis officia" }, { "key": "exercitation", "highlightString": "officia pariatur nulla incididunt" }, { "key": "magna in dolore eu", "highlightString": "ullamco et quis exercitation" }, { "key": "cillum magna eu", "highlightString": "mollit incididunt" }, { "key": "non", "highlightString": "laboris et" } ], "status": "complete", "previous": { "incomplete": [ "workflow_end" ], "complete": [ "workflow_start", "workflow_end" ], "error": [ "workflow_start", "error_handler", "error_handler", "3a1f", "3a1f" ] }, "taskId": "workflow_start", "transitions": { "success": [ { "task": "error_handler", "type": "loop" } ], "failure": [ { "task": "workflow_start", "type": "loop" }, { "task": "e28f", "type": "revert" }, { "task": "error_handler", "type": "loop" } ], "error": [ { "task": "3a1f", "type": "revert" }, { "task": "3a1f", "type": "standard" }, { "task": "error_handler", "type": "standard" }, { "task": "3a1f", "type": "standard" }, { "task": "workflow_start", "type": "loop" } ] }, "serverId": "fugiat", "start_time": "2005-09-10T09:52:22.776Z", "end_time": -78055191.76186961, "finish_state": "success", "retrySettings": null, "type": "operation", "actor": "job", "groups": [ "default", "ba0cec6f71c7af6ed2b010ce", "bd68f9ee1fa35d00b22976bd", "default" ], "iterations": [ "b252c621-848B-B2EC-2Aa6-73DDA5bBdbDf" ] }, "e": { "x": 55524237.1466372, "y": 4061968.9026935846, "gridCoordinate": { "x": 12786143.544410184, "y": -28701335.22970742 }, "name": "in Ut Duis in", "location": "Broker", "locationType": "aliqua in ut", "app": "qui", "canvasName": "incididunt et aute adipisicing", "displayName": "irure", "summary": "nisi amet sint", "description": "in adipisicing", "variables": { "error": "", "decorators": [ { "type": "encryption", "pointer": "/~0/~0/~0/WIqoa/~0/~1" }, { "type": "encryption", "pointer": "/cEkP/pnAdnYjIYP/qGtB-Ps5J/dwCK71M/Td" } ] }, "deprecated": true, "scheduled": true, "matched": [ { "key": "dolor", "highlightString": "cillum Excepteur velit" } ], "status": "incomplete", "previous": { "incomplete": [ "workflow_end", "workflow_end" ], "complete": [ "workflow_start", "error_handler" ], "error": [ "e28f" ] }, "taskId": "workflow_start", "transitions": { "success": [ { "task": "workflow_end", "type": "standard" }, { "task": "workflow_start", "type": "loop" } ], "failure": [ { "task": "3a1f", "type": "revert" }, { "task": "error_handler", "type": "standard" } ], "error": [ { "task": "workflow_start", "type": "standard" }, { "task": "workflow_end", "type": "loop" }, { "task": "workflow_end", "type": "revert" }, { "task": "e28f", "type": "loop" }, { "task": "3a1f", "type": "standard" } ] }, "serverId": "nulla", "start_time": "1978-04-09T07:44:59.544Z", "end_time": 27654828.381892666, "finish_state": "error", "retrySettings": { "state": [ "success", "error" ], "autoRetry": false, "limit": 76891789, "delay": 20113462, "count": 64251127, "finishedRetrying": false }, "type": "operation", "actor": null, "groups": [ "2e6640d16ded4a321a219203", "8d792004a4e4aa66cafd00d7", "default", "default" ], "iterations": [ "Cc0cB492-D8b8-62ED-e776-3d478d1EBA40" ] } }, "parent": { "task": "deserunt ullamco Excepteur", "iteration": -78890195.15788904, "element": 24053506.020550415 }, "errorHandler": null, "groups": [ { "_id": "a76634ce5696731453439920", "provenance": "laboris Excepteur quis", "name": "et sit", "description": "anim dolore dolore incididunt Duis", "memberOf": [ { "groupId": "18ce6286905e4315d185feb3", "aaaManaged": true }, { "groupId": "925ab34c332e906daa3654b9", "aaaManaged": false }, { "groupId": "6487c6744dda929cde56a227", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "proident eiusmod" }, { "roleId": "proident esse cillum ipsum pariatur" }, { "roleId": "exercitation" } ], "inactive": true, "_meta": { "created": "2024-01-22T23:23:00.714Z", "updated": "2010-04-07T17:13:43.097Z", "migrationVersion": -13904446 } }, "default", "15830be257076869d3595a26" ], "watchers": [ { "_id": "0bcad6afd50fec13ed1dc9e4", "provenance": "ut labore", "username": "dolor laboris adipisicing", "firstname": "non", "memberOf": [ { "groupId": "a96c0d08d8152476ca837644", "aaaManaged": true }, { "groupId": "b289ab1e9a2360a50d9f8490", "aaaManaged": false }, { "groupId": "f9f4dfb8510f89b0b9a5f5cf", "aaaManaged": false }, { "groupId": "cbd74bdefcf17c178f1ec17f", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "in" } ], "inactive": true, "lastLogin": "2005-04-08T03:34:00.184Z", "_meta": { "created": "1974-04-30T09:33:46.017Z", "updated": "1969-09-29T22:58:40.534Z", "migrationVersion": 72456570 }, "email": "ut nulla tempor non anim" }, null ], "metrics": { "start_time": -36061653.51341994, "progress": 0.15791942849696894, "end_time": -75909526.01066108, "user": { "_id": "6f3622712d699d5b3b472e50", "provenance": "Lorem officia", "username": "occaecat nisi labore qui proident", "firstname": "qui ut", "memberOf": [ { "groupId": "5c565e04d81f9c7300ee1d83", "aaaManaged": true }, { "groupId": "50201f1536cedeec57f0ce66", "aaaManaged": false }, { "groupId": "c82094f3b4de47a1e5e783dc", "aaaManaged": true }, { "groupId": "e6e09f67dd86177706a67b9b", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "consequat officia" }, { "roleId": "et consectetur aute velit" }, { "roleId": "aliquip" } ], "inactive": true, "lastLogin": "1947-10-03T20:53:52.677Z", "_meta": { "created": "1979-01-19T18:17:33.052Z", "updated": "1955-12-04T18:31:42.158Z", "migrationVersion": -66594532 }, "email": "esse Ut" }, "owner": null } } }
{ "title": "job", "allOf": [ { "$ref": "common-api#/definitions/success-response" }, { "type": "object", "properties": { "data": { "$ref": "job-api" } } } ] }