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": "et in", "options": { "description": "Example job description", "type": "automation", "groups": [ "f6d4cda2af4fc3ab8e2a6f74", "bab63d8cda4971f9ba969889" ] } }
{ "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": "e16f0b5aea0f533dda874b23", "font_size": 85589719, "type": "automation", "created": "1993-05-27T13:07:59.21Z", "last_updated": "1955-11-14T14:23:42.294Z", "createdVersion": "41.62.3", "lastUpdatedVersion": "9026520.791013.370665-0176.661.97042402", "canvasVersion": 1.5, "encodingVersion": 1, "migrationVersion": -24612156, "name": "myCoolDocumentName", "description": "Some helpful information about the document", "preAutomationTime": -44587284.629678205, "sla": 96801190.25296041, "decorators": [ { "type": "encryption", "pointer": "/~1/PVTmb/~1/~1/pbcn0/~1/~0" }, { "type": "encryption", "pointer": "/ECS7JxSM./O,/~1/~1/~0/~0/I/~0/~1/~0" }, { "type": "encryption", "pointer": "/y8A/~0/Hym/~0/YBHJbrxy." }, { "type": "encryption", "pointer": "/j,t7MU/jHW//E6hXd/~1/SOn/~0" }, { "type": "encryption", "pointer": "/Lm,Pu/~1/~1/O4lz3B0g/~0/NNU7/~1/hnfB/fSovLs/~1/~1" } ], "status": "incomplete", "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 } ], "warnings": [ { "task": "workflow_start", "name": "myCoolDocumentName" }, { "task": "e28f", "name": "myCoolDocumentName" }, { "task": "error_handler", "name": "myCoolDocumentName", "message": "irure Excepteur" }, { "task": "3a1f", "name": "myCoolDocumentName" } ], "ancestors": [ "c094cfd80ed0afee707257c2", "b40d8c556fd7aeb2d2bf3cb0", "74d69baaba4431083f60c836", "ec1711596ca45e163526798d", "c9826dadefe69812eef98c60" ], "validationErrors": [ { "keyword": "aliqua", "dataPath": "irure commodo in velit do", "schemaPath": "dolore cillum aliqua", "message": "voluptate cupidatat sunt ad officia" }, { "keyword": "laborum pariatur", "dataPath": "nulla in", "schemaPath": "sit minim proident amet", "message": "laborum reprehenderit ullamco" }, { "keyword": "in sint", "dataPath": "in", "schemaPath": "eu veniam cillum deserunt", "message": "labore veniam quis consequat" } ], "created_by": { "_id": "fc9b5effa5a15981f1371ed0", "provenance": "ullamco id", "username": "Lorem", "firstname": "anim nisi irure tempor Duis", "memberOf": [ { "groupId": "c9d70016987fb62ce05127cf", "aaaManaged": true }, { "groupId": "a3923856b527e499bec6516b", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "sunt occaecat dolore" }, { "roleId": "in quis et commodo voluptate" }, { "roleId": "tempor" } ], "inactive": true, "lastLogin": "1979-02-03T06:54:49.0Z", "_meta": { "created": "2012-08-03T05:05:40.94Z", "updated": "2004-12-05T15:18:39.278Z", "migrationVersion": 46147366 }, "email": "ullamco" }, "last_updated_by": "Pronghorn", "tasks": { "workflow_start": { "x": -95161131.33871071, "y": -51968388.34471218, "gridCoordinate": { "x": -14028990.086184084, "y": -84129416.6951733 }, "name": "workflow_start", "summary": "workflow_start", "taskId": "workflow_start", "metrics": { "start_time": 77297780.69899246, "finish_state": "failure", "user": { "_id": "ace9d6080f26bcfdd26f8e64", "provenance": "in ut enim nisi quis", "username": "cillum culpa deserunt consectetur anim", "firstname": "consequat in amet", "memberOf": [ { "groupId": "90bb7384de4ab44e34a8c727", "aaaManaged": true }, { "groupId": "7b6ed709bdc9529ad1604543", "aaaManaged": true }, { "groupId": "98f919f67a051a2e95854b27", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "consequat" }, { "roleId": "pariatur eiusmod aliquip" } ], "inactive": false, "lastLogin": "1959-05-11T07:20:50.809Z", "_meta": { "created": "1970-11-21T00:07:25.679Z", "updated": "1980-10-19T21:18:26.227Z", "migrationVersion": -96805975 }, "email": "magna" } }, "groups": [ "default", "default", "default", { "_id": "965a19c5225b4e4727958676", "provenance": "aliqua Lorem", "name": "non deserunt quis", "description": "ipsum cillum ullamco", "memberOf": [ { "groupId": "f7952bf18e03d49f7ec73a84", "aaaManaged": true }, { "groupId": "c905f7e5dc3369e6a48bb780", "aaaManaged": true }, { "groupId": "605c210adf856c1b626f0c40", "aaaManaged": false }, { "groupId": "73dbb34e86b32f0192f95211", "aaaManaged": true }, { "groupId": "c490655dcd82211c47c90c1d", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "amet in est dolor" }, { "roleId": "eiusmod" } ], "inactive": true, "_meta": { "created": "2008-03-06T21:04:43.182Z", "updated": "1955-11-09T23:53:05.069Z", "migrationVersion": 78365733 } } ], "iterations": [ "C3872A7d-a52D-e0d5-Efe1-69bF4b7Ccd89", "0aF1FaC6-C3D7-d22A-a8BF-FDd0C632ee2F" ] }, "workflow_end": { "x": -4174039.1136392057, "y": -48678577.782507524, "gridCoordinate": { "x": 97407939.74053732, "y": -43751620.29237884 }, "name": "workflow_end", "summary": "workflow_end", "taskId": "workflow_end", "endTasks": { "incomplete": [ "error_handler", "error_handler", "workflow_start" ], "complete": [ "error_handler", "workflow_start", "workflow_start", "3a1f", "e28f" ], "error": [ "workflow_start", "error_handler" ] }, "metrics": { "end_time": -57767793.80685291, "run_time": 56589228.977256626 }, "groups": [ "ceabd2bbc82c8a499a3fbd7d", "default", "e09b6d618a3024fb68f0dc26", "default", "aa80501bb62a2e9e19a299d1" ], "iterations": [ "F6Eea577-4d7b-92E6-8f7b-b08Fa63F8A47", "Ec5EbDf7-0c8a-bD48-3E57-3c085E493897" ] }, "error_handler": { "x": -24558483.48110874, "y": -34073324.286658876, "gridCoordinate": { "x": 14771214.718613729, "y": 95622617.92187643 }, "name": "childJob", "location": "Broker", "locationType": "sit magna ea et", "app": "Lorem consequat", "canvasName": "occaecat enim reprehenderit", "displayName": "Duis officia veniam in", "summary": "exercitation irure consectetur culpa proident", "description": "Duis tempor aute", "variables": { "error": "", "decorators": [ { "type": "encryption", "pointer": "/T7yAeA/~0/~0" } ] }, "deprecated": false, "scheduled": true, "matched": [ { "key": "officia", "highlightString": "aliqua laborum" } ], "status": "paused", "previous": { "incomplete": [ "3a1f" ], "complete": [ "workflow_start", "workflow_start" ], "error": [ "error_handler", "workflow_start" ] }, "taskId": "e28f", "transitions": { "success": [ { "task": "workflow_end", "type": "revert" }, { "task": "workflow_end", "type": "loop" } ], "failure": [ { "task": "3a1f", "type": "standard" }, { "task": "error_handler", "type": "revert" }, { "task": "3a1f", "type": "revert" }, { "task": "workflow_start", "type": "revert" }, { "task": "workflow_end", "type": "standard" } ], "error": [ { "task": "error_handler", "type": "loop" }, { "task": "error_handler", "type": "standard" }, { "task": "3a1f", "type": "revert" }, { "task": "e28f", "type": "revert" }, { "task": "workflow_end", "type": "standard" } ] }, "serverId": "laboris voluptate", "start_time": "1982-05-01T20:03:36.889Z", "end_time": -96589278.2246553, "finish_state": "error", "retrySettings": null, "type": "operation", "actor": "job", "groups": [ { "_id": "23ea029fba44181d9275f882", "provenance": "ut est do Duis", "name": "laboris ad aliqua", "description": "laboris Ut", "memberOf": [ { "groupId": "0af792fd9c9aec3bb9b55b17", "aaaManaged": true }, { "groupId": "888b2071a26c7a3ef46ad53d", "aaaManaged": false }, { "groupId": "56e764b707460e6a9f22cef0", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "laboris sit eiusmod incididunt" }, { "roleId": "dolore Ut Excepteur" }, { "roleId": "do sed elit cillum sint" } ], "inactive": true, "_meta": { "created": "1956-12-06T02:59:48.987Z", "updated": "1955-03-31T03:28:55.91Z", "migrationVersion": 10896891 } }, { "_id": "5ae6fab8c73dd2c357a95ec8", "provenance": "Ut Excepteur", "name": "adipisicing pariatur est cupidatat ipsum", "description": "minim ad dolor do", "memberOf": [ { "groupId": "03d5b9922d199ebac49f2324", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "aliquip in ad exercitation consequat" }, { "roleId": "aute officia ex" }, { "roleId": "in esse mollit aute commodo" } ], "inactive": true, "_meta": { "created": "2020-10-13T12:22:15.666Z", "updated": "2021-05-27T18:32:06.92Z", "migrationVersion": -73218997 } }, "default", "34e905f63700cc00468442a1", "default" ], "iterations": [ "aF7F6A09-6De9-093a-Da31-C2aDD5AD55CE" ] }, "6e40": { "actor": "job", "groups": [ "default", "default", { "_id": "09f796c3de5fbd1e3109f08b", "provenance": "et eiusmod quis occaecat Excepteur", "name": "id", "description": "consectetur", "memberOf": [ { "groupId": "65b42c7f0aa41bb5dafcb9fa", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "id sed qui commodo quis" }, { "roleId": "in magna dolore occaecat voluptate" }, { "roleId": "ea" } ], "inactive": true, "_meta": { "created": "1977-04-24T09:41:26.684Z", "updated": "1953-09-04T08:03:14.784Z", "migrationVersion": 54488414 } } ], "iterations": [ "5e4EDCBb-7E9A-2cCd-A9ca-2c1e970caB9C" ], "x": -99748452.49427147, "y": 36394654.9517518, "gridCoordinate": { "x": 66219860.28412098, "y": -19004078.947567612 }, "name": "pending", "summary": "Ut sit commodo", "description": "nostrud culpa ex" } }, "parent": { "task": "minim", "iteration": 7022631.643661097, "element": -13807771.110522717 }, "errorHandler": { "actor": "job", "groups": [ { "_id": "8d4b11dc272fffe5b070f79e", "provenance": "dolor eu exercitation do et", "name": "aliqua minim id ad sint", "description": "ex esse in anim cupidatat", "memberOf": [ { "groupId": "9e32c0b3f1fcfa244af804ed", "aaaManaged": true }, { "groupId": "0ed09be379b9d2e08f0afd26", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "ut nisi dolore deserunt tempor" }, { "roleId": "do aliquip enim exercitation aliqua" }, { "roleId": "anim dolore" }, { "roleId": "amet" }, { "roleId": "est aliquip do" } ], "inactive": true, "_meta": { "created": "1957-10-07T23:24:46.465Z", "updated": "1971-03-01T16:40:55.39Z", "migrationVersion": 91274989 } }, "default" ], "iterations": [ "afe2D9AB-470C-98f6-ed8D-e88FD2e9d9fa" ], "x": 26798959.24502316, "y": -57564963.088970035, "gridCoordinate": { "x": -21514999.04728435, "y": -28490437.155155316 }, "name": "pending", "summary": "reprehenderit", "description": "elit qui magna" }, "groups": [ "ae2ec2b9103249fea7308714", { "_id": "3b0fced70ae19ef621121466", "provenance": "fugiat ut culpa eu sed", "name": "aliqua", "description": "laborum Lorem", "memberOf": [ { "groupId": "fdb2815553449d3a7b15ba49", "aaaManaged": true }, { "groupId": "d796c581cb481541af6885db", "aaaManaged": true }, { "groupId": "aea5c5b870aab8b9748a3c41", "aaaManaged": true }, { "groupId": "8b9d33646dab271cbbf1a352", "aaaManaged": true }, { "groupId": "5cf61d2d4e310d98582aa245", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "mollit eu qui" }, { "roleId": "veniam id in consequat ut" } ], "inactive": false, "_meta": { "created": "1955-08-28T02:40:40.667Z", "updated": "1959-03-21T16:19:08.544Z", "migrationVersion": 35531632 } }, "a6ebaa302eca8f61eaae94f5" ], "watchers": [ null, "Pronghorn", "b08da95675c0b3b82dac39f4", "6d93ae3fff4eb0bdff096769", "Pronghorn" ], "metrics": { "start_time": 33156346.558585435, "progress": 0.6049458440299496, "end_time": 92602032.99740666, "user": "Pronghorn", "owner": "df86aba9234f097368f5def8" } } }
{ "title": "job", "allOf": [ { "$ref": "common-api#/definitions/success-response" }, { "type": "object", "properties": { "data": { "$ref": "job-api" } } } ] }