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": "aliqua do ut Duis", "options": { "description": "Example job description", "type": "automation", "groups": [ "4b2a131236eeed26e1518e33", "1c834c4139b4f77f465b0d76", "e06855a8d173f088b25350e7", "7bf61f104a135625a42a9b2c" ] } }
{ "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": "117b728f94a18556197e3e7f", "font_size": 48091096, "type": "resource:action", "created": "2020-05-15T14:47:46.903Z", "last_updated": "1968-08-10T23:23:31.285Z", "createdVersion": "858725.783.083135186-5933.2500398804.55887.67058525", "lastUpdatedVersion": "094.17310301.99050046-8768.4741.3.5917547031", "canvasVersion": 2, "encodingVersion": 1, "migrationVersion": 90090818, "name": "myCoolDocumentName", "description": "Some helpful information about the document", "preAutomationTime": 35898161.87158042, "sla": -36388537.247691356, "decorators": [ { "type": "encryption", "pointer": "/~0/~1/~0/yxu-z0N7" }, { "type": "encryption", "pointer": "/~1/TN" }, { "type": "encryption", "pointer": "/Pp/GOXR/xCAx/GqhxuXrdL//~1/Uu/Y" }, { "type": "encryption", "pointer": "/~1/~1/wR5pyAKd3/i9k/~0/~1/DNv." }, { "type": "encryption", "pointer": "/~0/~1/Crfam/n" } ], "status": "running", "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": "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": "e28f", "name": "myCoolDocumentName", "message": "tempor proident" }, { "task": "error_handler", "name": "myCoolDocumentName", "message": "nulla" }, { "task": "error_handler", "name": "myCoolDocumentName" }, { "task": "error_handler", "name": "myCoolDocumentName" }, { "task": "error_handler", "name": "myCoolDocumentName", "message": "ex" } ], "ancestors": null, "validationErrors": [ { "keyword": "elit irure cillum Excepteur incididunt", "dataPath": "proident pariatur", "schemaPath": "aute dolore quis mollit adipisicing", "message": "mollit anim deserunt do" }, { "keyword": "qui ex", "dataPath": "incididunt esse nulla", "schemaPath": "sint Lorem ea", "message": "in minim" }, { "keyword": "amet", "dataPath": "Lorem ex quis", "schemaPath": "commodo", "message": "dolor velit sunt" }, { "keyword": "in anim exercitation mollit", "dataPath": "quis ut ad", "schemaPath": "minim ipsum esse", "message": "exercitation in non" }, { "keyword": "mollit ullamco dolore in ut", "dataPath": "quis", "schemaPath": "quis in dolor in", "message": "sit ad" } ], "created_by": { "_id": "3027429ca50d82383be1cc3a", "provenance": "dolore aute eu fugiat", "username": "nisi", "firstname": "amet enim", "memberOf": [ { "groupId": "b3d33c01506c5cd1f1f13390", "aaaManaged": false }, { "groupId": "3d5deb483e16272acfe49afe", "aaaManaged": true }, { "groupId": "ed3f85955c1b3b6deb563b4a", "aaaManaged": true }, { "groupId": "1c2534e26f52b115a5bcad4d", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "commodo" }, { "roleId": "consectetur deserunt in" }, { "roleId": "ullamco officia" }, { "roleId": "est" }, { "roleId": "sint quis in ex Duis" } ], "inactive": true, "lastLogin": "1994-07-10T12:00:38.526Z", "_meta": { "created": "1973-02-12T21:01:27.015Z", "updated": "1972-03-28T13:13:15.202Z", "migrationVersion": 93607564 }, "email": "ex commodo veniam proident tempor" }, "last_updated_by": "c0a6acb47a4db4302bedcb57", "tasks": { "workflow_start": { "x": 57160942.02362004, "y": 96235935.8766833, "gridCoordinate": { "x": 94010023.7954872, "y": -77870628.29186824 }, "name": "workflow_start", "summary": "workflow_start", "taskId": "workflow_start", "metrics": { "start_time": -58409943.30648685, "finish_state": "success", "user": "Pronghorn" }, "groups": [ "default", { "_id": "f393f0fe139a4ea10f5a93b2", "provenance": "nisi aliqua in sed minim", "name": "exercitation pariatur do ullamco et", "description": "adipisicing id quis", "memberOf": [ { "groupId": "2209ae85eba2244302bb6db8", "aaaManaged": true }, { "groupId": "8b5b65f45e7052f4fb6af941", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "nulla occaecat" }, { "roleId": "ut elit ea consequat Lorem" }, { "roleId": "mollit pariatur" }, { "roleId": "dolor aliqua elit" }, { "roleId": "enim velit elit mollit laborum" } ], "inactive": true, "_meta": { "created": "1970-03-11T13:00:45.341Z", "updated": "2021-08-07T14:57:36.836Z", "migrationVersion": -9225224 } }, "9082a02bd9b9b9a9042f9e84" ], "iterations": [ "076ADed3-CebF-cEDe-3d68-eAaF37fa21Cf", "90004bae-32Df-aE39-c01b-06DAab287ec6" ] }, "workflow_end": { "x": -16265103.736693472, "y": 38787894.49549562, "gridCoordinate": { "x": -34537293.888529554, "y": -98243374.32495143 }, "name": "workflow_end", "summary": "workflow_end", "taskId": "workflow_end", "endTasks": { "incomplete": [ "3a1f", "workflow_start" ], "complete": [ "e28f", "e28f", "e28f" ], "error": [ "3a1f", "error_handler" ] }, "metrics": { "end_time": -81041982.31934312, "run_time": -89950919.12166396 }, "groups": [ "default", "d2486d8e27029ea6a57cfaf8", { "_id": "45d517d246c57783e0cc292d", "provenance": "ut", "name": "ullamco", "description": "adipisicing consectetur esse", "memberOf": [ { "groupId": "fc5bcd4f236feee3bd6983da", "aaaManaged": true }, { "groupId": "a324a7e0a924131f4a5cb2bc", "aaaManaged": true }, { "groupId": "dadce6327085a436796674ff", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "aliquip dolore in laborum" } ], "inactive": false, "_meta": { "created": "1972-08-27T02:19:45.428Z", "updated": "1995-06-29T09:28:36.381Z", "migrationVersion": 77653684 } }, { "_id": "409ca94da40fb45a35ad1a26", "provenance": "velit dolor ipsum exercitation", "name": "sint aliqua laboris", "description": "proident sit cupidatat", "memberOf": [ { "groupId": "f01565fa0ac6ad179156eb42", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "consequat ea" }, { "roleId": "commodo" } ], "inactive": true, "_meta": { "created": "1958-03-23T13:16:10.796Z", "updated": "1949-04-07T06:55:53.568Z", "migrationVersion": -31420522 } }, "default" ], "iterations": [ "ed426D10-2FB5-eE49-E479-De977Bf10F5A" ] }, "error_handler": { "x": 95743476.05828643, "y": -7811058.836082011, "gridCoordinate": { "x": -82106478.01254863, "y": 5741186.223808765 }, "name": "childJob", "location": "Adapter", "locationType": null, "app": "esse eu", "canvasName": "eiusmod sed", "displayName": "culpa magna nostrud veniam", "summary": "nostrud ea in", "description": "pariatur in", "variables": { "error": "", "decorators": [ { "type": "encryption", "pointer": "/E" }, { "type": "encryption", "pointer": "/BS/~0/xy/rglz/~1/K2Hj/dGGgUBza/~0" } ] }, "deprecated": true, "scheduled": true, "matched": [ { "key": "ut officia", "highlightString": "magna pariatur ut reprehenderit est" }, { "key": "dolor", "highlightString": "Duis voluptate sint commodo ad" }, { "key": "deserunt", "highlightString": "aliqua tempor sed" } ], "status": "canceled", "previous": { "incomplete": [ "error_handler", "3a1f", "workflow_end", "error_handler" ], "complete": [ "e28f", "error_handler", "workflow_start" ], "error": [ "workflow_start", "error_handler" ] }, "taskId": "workflow_end", "transitions": { "success": [ { "task": "workflow_start", "type": "standard" }, { "task": "e28f", "type": "revert" }, { "task": "workflow_end", "type": "revert" } ], "failure": [ { "task": "workflow_end", "type": "revert" } ], "error": [ { "task": "error_handler", "type": "loop" } ] }, "serverId": "cillum tempor Excepteur reprehenderit", "start_time": "1954-01-02T23:46:16.386Z", "end_time": -50559897.78083441, "finish_state": "success", "retrySettings": null, "type": "operation", "actor": "job", "groups": [ "default", "default", "2437f5a23532ab92d9224174", { "_id": "d134499848ab2fecb0709df5", "provenance": "reprehenderit id enim veniam dolore", "name": "labore anim enim in exercitation", "description": "magna in cupidatat aliqua eu", "memberOf": [ { "groupId": "4120bd579ffa1e9315ef94cb", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "veniam est" }, { "roleId": "minim ex deserunt ullamco" }, { "roleId": "laboris occaecat non dolore" }, { "roleId": "officia" }, { "roleId": "deserunt ut" } ], "inactive": true, "_meta": { "created": "1997-02-09T04:01:12.048Z", "updated": "2007-08-31T03:25:33.411Z", "migrationVersion": 38288467 } }, { "_id": "29595f87915b135ef02b0ec7", "provenance": "do voluptate mollit tempor", "name": "nulla", "description": "proident laborum commodo Lorem amet", "memberOf": [ { "groupId": "bd9d25a51adb6fccf5ceb1b7", "aaaManaged": false }, { "groupId": "509474bec08605471bd4f409", "aaaManaged": true }, { "groupId": "8a8877b10831ecad36fd6fec", "aaaManaged": true }, { "groupId": "2ce1236fffcceddc03f5dad3", "aaaManaged": false }, { "groupId": "5d7d043dd03909338f4258c7", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "ut ipsum veniam incididunt in" }, { "roleId": "eiusmod" }, { "roleId": "amet enim consectetur" }, { "roleId": "Lorem aliqua Excepteur aute nulla" } ], "inactive": false, "_meta": { "created": "2025-02-23T18:09:38.468Z", "updated": "1998-08-20T03:48:10.785Z", "migrationVersion": -3154880 } } ], "iterations": [ "9AAEa1A6-fef4-C7E4-fEb9-b6C03bF0cabF" ] }, "4f7d": { "actor": "Pronghorn", "groups": [ { "_id": "e0c2900f44fa0a4b0a904bca", "provenance": "qui", "name": "deserunt", "description": "nulla Duis", "memberOf": [ { "groupId": "d369d2a4a603766bfc73285e", "aaaManaged": true }, { "groupId": "21185bfb7cd2c3c09f376da4", "aaaManaged": true }, { "groupId": "8796f567d2c8fd28db7aa7e9", "aaaManaged": false }, { "groupId": "2e209c40fb9149c6e6700778", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "laborum" }, { "roleId": "voluptate aliquip sint tempor ad" }, { "roleId": "laborum" }, { "roleId": "ipsum aliquip" } ], "inactive": false, "_meta": { "created": "1981-09-01T00:26:35.842Z", "updated": "1970-04-13T16:04:53.11Z", "migrationVersion": 76267773 } }, "default", "f157aed9f3d7607266b9e42e", "default", "724efe404fb1f5b8f5e5d536" ], "iterations": [ "4cdba0DD-BddC-14a0-Bb99-1166fcBf34Bc", "85BC0E5b-ee7E-0283-dE52-4CeeCCD1bFA3" ], "x": 15901405.951176882, "y": 40669352.32790363, "gridCoordinate": { "x": 7211152.48667106, "y": -10002244.991315529 }, "name": "amet dolor veniam do nisi", "location": "Application", "locationType": "voluptate nostrud", "app": "mollit irure Lorem", "canvasName": "childJob", "displayName": "nulla", "summary": "culpa est", "description": "consequat velit est dolore enim", "variables": { "error": "", "decorators": [ { "type": "encryption", "pointer": "/~1/N3/~1/FNca/~1" }, { "type": "encryption", "pointer": "/~0/dcIqdKUz/~1/sTG8O/~1/~0/nzvH7/NtR/~0/rmW5G/Te-u/~0" } ] }, "deprecated": false, "scheduled": true, "matched": [ { "key": "ut ut in nisi incididunt", "highlightString": "occaecat ad aute Excepteur" }, { "key": "dolore ullamco elit", "highlightString": "occaecat ut laboris quis ad" }, { "key": "sit qui nulla Lorem et", "highlightString": "enim" }, { "key": "eu Excepteur ut cupidatat occaecat", "highlightString": "nisi non et qui" } ], "status": "running", "previous": { "incomplete": [ "workflow_end", "workflow_start", "error_handler", "error_handler" ], "complete": [ "e28f", "workflow_start", "error_handler", "workflow_start", "3a1f" ], "error": [ "3a1f", "workflow_end" ] }, "taskId": "workflow_start", "transitions": { "success": [ { "task": "error_handler", "type": "standard" }, { "task": "workflow_end", "type": "revert" } ], "failure": [ { "task": "workflow_start", "type": "loop" }, { "task": "e28f", "type": "loop" }, { "task": "workflow_end", "type": "loop" }, { "task": "error_handler", "type": "standard" } ], "error": [ { "task": "workflow_end", "type": "standard" } ] }, "serverId": "ad", "start_time": "1949-04-23T07:34:32.986Z", "end_time": -30847274.463694423, "finish_state": "error", "retrySettings": null, "loop": { "atLeastOneComplete": false, "finishedCount": -5461336.6955778, "outgoing": [ "quis aliqua in laborum" ] }, "childJobs": [ { "_id": "Lorem dolor exercitation sit minim", "name": "voluptate Duis tempor", "iteration": 31271338.72304015 } ] } }, "parent": { "task": "commodo occaecat sed consequat labore", "iteration": -31184024.420675933, "element": -9948104.18542853 }, "errorHandler": { "actor": { "_id": "325970e4005fbfd216af2bd2", "provenance": "aliquip sit commodo exercitation irure", "username": "sit esse ut", "firstname": "ut commodo est id dolor", "memberOf": [ { "groupId": "faf5923ea0e1d423dd8ce515", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "quis" }, { "roleId": "eu" } ], "inactive": false, "lastLogin": "1948-05-05T20:06:41.46Z", "_meta": { "created": "1966-04-30T05:52:42.538Z", "updated": "1954-12-14T07:18:46.668Z", "migrationVersion": -73104190 }, "email": "ipsum tempor" }, "groups": [ { "_id": "fdf50fd208f50493c68095e9", "provenance": "laborum", "name": "dolore", "description": "non adipisicing Ut", "memberOf": [ { "groupId": "3499318f5f425c2ff6d21976", "aaaManaged": false }, { "groupId": "f654d198b86583e5f500b0ad", "aaaManaged": true }, { "groupId": "7883f9e187b2c8dc594bc411", "aaaManaged": true }, { "groupId": "9238c19cc0f31f7b526026f1", "aaaManaged": false }, { "groupId": "6b7d165e1d7cec328ae679c9", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "dolore occaecat nostrud dolore velit" } ], "inactive": false, "_meta": { "created": "1957-10-16T04:20:46.384Z", "updated": "2003-01-02T15:06:47.618Z", "migrationVersion": -43091769 } }, "3aafe3745de01813f2e635aa", "default", "default", "8d92aff450a0fafe4b32f5f6" ], "iterations": [], "x": 89141918.33172965, "y": 81158053.00420037, "gridCoordinate": { "x": -39137287.22742622, "y": -90545165.61975631 }, "name": "et ea commodo nisi", "location": "Adapter", "locationType": "in", "app": "Ut qui proident aliqua", "canvasName": "childJob", "displayName": "dolore sed non sit", "summary": "elit dolor magna Excepteur", "description": "in pariatur veniam quis adipisicing", "variables": { "error": "", "decorators": [ { "type": "encryption", "pointer": "/cdkORKKAf20/G/~1/~0/~1/~1/f/~1/~0" }, { "type": "encryption", "pointer": "/~1/AkGiH8A/pSFTf/rZS.SJ3dD/ZCU/SU6tsLv/rcIIYV7iy" }, { "type": "encryption", "pointer": "/~1/aoCPWh0sW/~1/~1" }, { "type": "encryption", "pointer": "/~0/~0/~1" } ] }, "deprecated": false, "scheduled": false, "matched": [ { "key": "nisi", "highlightString": "nisi ex id ut Excepteur" }, { "key": "voluptate quis Ut dolore", "highlightString": "id" }, { "key": "magna dolore et reprehenderit", "highlightString": "nisi" }, { "key": "aliqua aliquip nostrud", "highlightString": "pariatur exercitation fugiat in" }, { "key": "commodo", "highlightString": "cupidatat mollit" } ], "status": "complete", "previous": { "incomplete": [ "3a1f", "error_handler", "e28f", "3a1f", "workflow_start" ], "complete": [ "workflow_start", "workflow_end", "error_handler" ], "error": [ "workflow_end", "workflow_start", "error_handler", "workflow_end" ] }, "taskId": "e28f", "transitions": { "success": [ { "task": "e28f", "type": "loop" } ], "failure": [ { "task": "e28f", "type": "revert" }, { "task": "workflow_end", "type": "standard" }, { "task": "error_handler", "type": "revert" }, { "task": "error_handler", "type": "revert" }, { "task": "error_handler", "type": "standard" } ], "error": [ { "task": "3a1f", "type": "standard" } ] }, "serverId": "in", "start_time": "1962-08-24T23:14:06.907Z", "end_time": 71967606.65756178, "finish_state": "error", "retrySettings": null, "loop": { "atLeastOneComplete": true, "finishedCount": 90700070.01023215, "outgoing": [ null, "officia", "minim veniam Ut qui nisi", null ] }, "childJobs": [ { "_id": "nisi qui ut ullamco elit", "name": "labore exercitation sed ipsum Ut", "iteration": 19360023.560780793 }, { "_id": "irure aute ad exercitation", "name": "enim occaecat ea eu", "iteration": 14760941.610503048 }, { "_id": "dolor veniam", "name": "nulla ipsum mollit ullamco commodo", "iteration": 62834761.856959164 } ] }, "groups": [ "default" ], "watchers": [ "1bd989a3238873bb23ce4b78", null ], "metrics": { "start_time": -98577089.18025918, "progress": 0.36819286308741583, "end_time": -50226166.979617395, "user": "7e4aad61af9dbfd7a3db4fce", "owner": "Pronghorn" } } }
{ "title": "job", "allOf": [ { "$ref": "common-api#/definitions/success-response" }, { "type": "object", "properties": { "data": { "$ref": "job-api" } } } ] }