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": "velit do Duis", "options": { "description": "Example job description", "type": "automation", "groups": [ "475fe77a8499815a26aad699", "affa4e9fbaf1efdef6621882", "1a05db5ee43fef37e744805c", "e5096c64697d8223368aced7", "b0e38ef3b5e21db490ee1861" ] } }
{ "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": "0fdf6718a40a2fa0dfbe8133", "font_size": -30838744, "type": "automation", "created": "2011-02-13T09:32:38.059Z", "last_updated": "1955-07-03T23:35:14.298Z", "createdVersion": "2086060312.04594568370.01", "lastUpdatedVersion": "852183226.76577030538.2118-7657.10940260538.99127705.0", "canvasVersion": 1.5, "encodingVersion": 1, "migrationVersion": -47897514, "name": "myCoolDocumentName", "description": "Some helpful information about the document", "preAutomationTime": 29034664.762195155, "sla": -604781.6706122458, "decorators": [ { "type": "encryption", "pointer": "/~1/AJVaNAJ0H/~0/ZbuC" }, { "type": "encryption", "pointer": "/OTkuR./t/~1/~1/sWP/~0/~1/~0/PL/~0" }, { "type": "encryption", "pointer": "/~0/Dj5q+V1/~1/~0/~1/~1/~1" }, { "type": "encryption", "pointer": "/g7gq/IM/MK3Aj/~1/~1" }, { "type": "encryption", "pointer": "/~0/QzRzcZiZzR+/bxO.Vy/VTYW+j/~0/sE,iU/~1/ms.fTR2v/~0/~1/~0" } ], "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": "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": "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 } ], "warnings": [ { "task": "workflow_start", "name": "myCoolDocumentName" }, { "task": "workflow_start", "name": "myCoolDocumentName" }, { "task": "3a1f", "name": "myCoolDocumentName", "message": "ipsum" } ], "ancestors": [ "7636b46d1bf49994e01cb07b", "ff13a6e925a5ca908f8fd74c" ], "validationErrors": [ { "keyword": "incididunt amet tempor Lorem", "instancePath": "cupidatat", "schemaPath": "nisi reprehenderit", "message": "irure ut qui adipisicing commodo" }, { "keyword": "ex esse", "instancePath": "non fugiat", "schemaPath": "occaecat aute cillum sit", "message": "nisi eu" }, { "keyword": "laborum incididunt ut labore", "instancePath": "occaecat", "schemaPath": "aute officia cillum sint", "message": "adipisicing" }, { "keyword": "veniam reprehenderit aliqua laborum voluptate", "instancePath": "labore in voluptate incididunt", "schemaPath": "officia minim sed", "message": "Lorem" }, { "keyword": "ullamco", "instancePath": "sed reprehenderit", "schemaPath": "in", "message": "cupidatat ad sint amet minim" } ], "created_by": "Pronghorn", "last_updated_by": "Pronghorn", "tasks": { "workflow_start": { "x": -86186782.2847366, "y": 81021357.03628254, "gridCoordinate": { "x": -37502834.31612407, "y": 86036488.99849951 }, "name": "workflow_start", "summary": "workflow_start", "taskId": "workflow_start", "metrics": { "start_time": 15404211.229555205, "finish_state": "success", "user": { "_id": "77986097701bc074659c14e4", "provenance": "et non Excepteur eiusmod esse", "username": "aliqua", "firstname": "dolore sint proident voluptate id", "memberOf": [ { "groupId": "22c8bfd2f79c89a7b6ac7738", "aaaManaged": false }, { "groupId": "ba00723a513d8af4434bed8a", "aaaManaged": false }, { "groupId": "6f0c515658c87a0ec13376e9", "aaaManaged": false }, { "groupId": "dfd56a810f78151bef3a9bae", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "ut" }, { "roleId": "Duis in esse sint ut" }, { "roleId": "consectetur in magna dolore" } ], "inactive": true, "lastLogin": "2001-01-20T18:43:53.549Z", "_meta": { "created": "1973-11-12T07:59:13.937Z", "updated": "2008-01-01T09:47:29.69Z", "migrationVersion": 2028133 }, "email": "laboris" } }, "groups": [ "default", "fade54c0ae1d8028d26f17c9", { "_id": "90715b9b31a0612ed531cebf", "provenance": "ipsum aliquip", "name": "ut", "description": "aute nostrud do velit irure", "memberOf": [ { "groupId": "46cfef0c45a9425b5ce8e0d9", "aaaManaged": false }, { "groupId": "3d7b6c4035f2fe8bf1a9e695", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "ut anim ut velit ullamco" }, { "roleId": "do" } ], "inactive": true, "_meta": { "created": "1994-01-30T12:17:34.255Z", "updated": "1965-12-18T03:05:21.512Z", "migrationVersion": -3374961 } }, { "_id": "48e44620af8563f1e50d5766", "provenance": "irure ea Lorem", "name": "commodo", "description": "ut aliquip cillum pariatur", "memberOf": [ { "groupId": "e51c2f81f8110ff436181b12", "aaaManaged": false }, { "groupId": "e755265d373b367413454e1e", "aaaManaged": true }, { "groupId": "6065d7483ec284bc7a005b52", "aaaManaged": false }, { "groupId": "ea038c4df1c98378288a3175", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "anim exercitation eu non culpa" } ], "inactive": true, "_meta": { "created": "1993-07-30T17:50:02.369Z", "updated": "2015-12-15T15:57:24.918Z", "migrationVersion": -29616114 } } ], "iterations": [] }, "workflow_end": { "x": -15178522.005715102, "y": 77507528.82962579, "gridCoordinate": { "x": -53694297.34946607, "y": 25983533.943324894 }, "name": "workflow_end", "summary": "workflow_end", "taskId": "workflow_end", "endTasks": { "incomplete": [ "workflow_end" ], "complete": [ "workflow_start", "e28f", "workflow_start" ], "error": [ "workflow_start", "workflow_start", "workflow_start" ] }, "metrics": { "end_time": 40131569.22919133, "run_time": 86047230.30173668 }, "groups": [ "default", "a2625e45c17c49aa40af632f", { "_id": "438a16b589056530e480d606", "provenance": "ex culpa non", "name": "adipisicing aliqua occaecat", "description": "incididunt cillum anim officia", "memberOf": [ { "groupId": "0144da0088a23eaf71a4a055", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "Excepteur sed consectetur aliquip" }, { "roleId": "esse occaecat anim" }, { "roleId": "nulla occaecat eu dolor aute" }, { "roleId": "sit Ut" }, { "roleId": "id anim nisi eiusmod" } ], "inactive": false, "_meta": { "created": "1951-07-12T05:46:56.049Z", "updated": "1971-10-30T15:05:23.588Z", "migrationVersion": -70231394 } }, { "_id": "8327286afd8bda17d2d9c899", "provenance": "Excepteur", "name": "esse", "description": "aute magna eiusmod", "memberOf": [ { "groupId": "526628519af7be14aeaf13c4", "aaaManaged": false }, { "groupId": "042c7a89248eb17926d61730", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "in elit dolore" } ], "inactive": false, "_meta": { "created": "1955-04-17T11:51:04.761Z", "updated": "2009-05-10T22:34:37.909Z", "migrationVersion": -56612594 } }, { "_id": "c12bdb59c6af42e337222dea", "provenance": "sunt fugiat ipsum", "name": "anim ipsum", "description": "officia in dolore exercitation", "memberOf": [ { "groupId": "96fdac734291edaed98b4c3d", "aaaManaged": false }, { "groupId": "cb444f05e7cc4d6875319548", "aaaManaged": false }, { "groupId": "ac3508afe725dff9c33b05bc", "aaaManaged": false }, { "groupId": "01748872b0b81c01c792436b", "aaaManaged": true }, { "groupId": "a8f98fc9c401b6bebd8c2784", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "reprehenderit consequat quis" } ], "inactive": true, "_meta": { "created": "1945-10-15T04:51:23.877Z", "updated": "1947-01-23T06:02:59.006Z", "migrationVersion": 43487913 } } ], "iterations": [ "7B63Beda-aCd4-8445-B991-8EAbDeb1dD6F", "3bDcDEa1-785e-F5ec-C48C-6180FA7AfADa", "cdf4e53A-dFDe-3839-Cef2-5e3CD2E79a8D", "b6aC095e-ab6b-963F-7BAF-D404f9603Ce6" ] }, "error_handler": { "x": 46032885.81422639, "y": 32820842.409378365, "gridCoordinate": { "x": -74239406.48646411, "y": -44562142.24112371 }, "name": "childJob", "location": "Adapter", "locationType": null, "app": "amet eiusmod", "canvasName": "non Excepteur", "displayName": "consequat Ut ut", "summary": "aliqua", "description": "eiusmod pariatur ut eu", "variables": { "error": "", "decorators": [ { "type": "encryption", "pointer": "/~0/~1/~1/~1/~0/OXG/Q/L" }, { "type": "encryption", "pointer": "/~1/Z0YRCAj" }, { "type": "encryption", "pointer": "/~1/O/~1/~1/RSbHQ7/~1/~1/~1/XaQkdNb/a7a/qbPM37" }, { "type": "encryption", "pointer": "/~0/~0/~1/~1/gWAFR/~0/MOVE/~1" } ] }, "deprecated": false, "scheduled": false, "matched": [ { "key": "culpa esse eu consectetur anim", "highlightString": "ea exercitation qui dolore eu" }, { "key": "dolor esse", "highlightString": "sed" }, { "key": "laborum", "highlightString": "tempor incididunt anim dolor Lorem" }, { "key": "dolor", "highlightString": "reprehenderit" } ], "status": "paused", "previous": { "incomplete": [ "e28f", "workflow_end", "error_handler", "workflow_start" ], "complete": [ "e28f", "e28f" ], "error": [ "workflow_start", "workflow_start" ] }, "taskId": "3a1f", "transitions": { "success": [ { "task": "workflow_start", "type": "revert" } ], "failure": [ { "task": "workflow_start", "type": "revert" }, { "task": "workflow_end", "type": "standard" }, { "task": "error_handler", "type": "loop" }, { "task": "3a1f", "type": "revert" }, { "task": "workflow_start", "type": "standard" } ], "error": [ { "task": "workflow_start", "type": "revert" }, { "task": "workflow_start", "type": "loop" } ] }, "serverId": "Lorem amet Ut proident in", "start_time": "2004-10-30T15:42:00.277Z", "end_time": 89039093.23422393, "finish_state": "success", "retrySettings": null, "type": "operation", "actor": { "_id": "5cdf95176b73b560f6f4c464", "provenance": "id sint deserunt", "username": "nostrud in velit nulla", "firstname": "cupidatat", "memberOf": [ { "groupId": "831cdf83a5478e657a7913d5", "aaaManaged": false }, { "groupId": "38fc9169ed52780f52978392", "aaaManaged": true }, { "groupId": "201b06408fb20fb93490b57f", "aaaManaged": false }, { "groupId": "9c1a7468c000d81b96c0f285", "aaaManaged": false }, { "groupId": "3c024e1c967710673a5ea0e8", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "sit" }, { "roleId": "sunt" }, { "roleId": "culpa ullamco" } ], "inactive": true, "lastLogin": "2010-05-13T23:42:33.162Z", "_meta": { "created": "1962-12-11T05:47:57.897Z", "updated": "1966-08-28T08:35:08.988Z", "migrationVersion": 23707816 }, "email": "tempor aliqua anim ut amet" }, "groups": [ "default", "1c1d0779d6dce83d6fef9610", "a3f45f9307c2812a560fdbfd", "b0ee6d3c384e916d04a08d20", "db5351a7765897f022596584" ], "iterations": [ "df8bE3a3-bBc8-Ad02-a5b6-cc8aEFbd2de5" ] }, "f0a": { "actor": "a438a6288a08a3153eea2984", "groups": [ "3970fff9648ba3a4491b4a72", "6eba25082ac9f378d1f7bd14" ], "iterations": [], "x": -59300864.7185592, "y": 96578847.69057298, "gridCoordinate": { "x": 5968040.164676845, "y": 66623240.76058969 }, "name": "aute", "location": "Application", "locationType": "pariatur dolore occaecat reprehenderit mollit", "app": "exercitation ullamco irure mollit pariatur", "canvasName": "childJob", "displayName": "officia nulla", "summary": "deserunt Duis in", "description": "qui tempor", "variables": { "error": "", "decorators": [ { "type": "encryption", "pointer": "/~0/~1/~0/~0/~1/~1/~0/vPTF.M" }, { "type": "encryption", "pointer": "/Ot97/~1/~0/~1/n9/f15/~0/cc4b/GbNrXI9kVt/kqXzfpGrp3/M0hzfKz" }, { "type": "encryption", "pointer": "/~0/IwZm/CsG/fP/~1/CzUl17DN//~1" } ] }, "deprecated": true, "scheduled": true, "matched": [ { "key": "quis exercitation Ut incididunt", "highlightString": "minim" }, { "key": "proident ea officia labore id", "highlightString": "non" } ], "status": "paused", "previous": { "incomplete": [ "workflow_start" ], "complete": [ "error_handler", "error_handler", "workflow_end", "e28f" ], "error": [ "workflow_end", "workflow_start", "error_handler" ] }, "taskId": "3a1f", "transitions": { "success": [ { "task": "3a1f", "type": "standard" }, { "task": "error_handler", "type": "revert" } ], "failure": [ { "task": "workflow_start", "type": "revert" } ], "error": [ { "task": "3a1f", "type": "loop" }, { "task": "workflow_start", "type": "loop" }, { "task": "workflow_start", "type": "loop" }, { "task": "workflow_start", "type": "revert" }, { "task": "workflow_start", "type": "revert" } ] }, "serverId": "amet consequat", "start_time": "1967-05-25T06:53:50.564Z", "end_time": -55467446.074567795, "finish_state": "error", "retrySettings": { "state": [ "success", "failure", "success", "error", "failure" ], "autoRetry": true, "limit": 47220988, "delay": 33877923, "count": 45906290, "finishedRetrying": true }, "loop": { "atLeastOneComplete": true, "finishedCount": -66522089.511560485, "outgoing": [ null, "eu", null, null ] }, "childJobs": [ { "_id": "labore", "name": "exercitation in anim eu", "iteration": -46242947.844043195 } ] } }, "parent": { "task": "exercitation minim est mollit consequat", "iteration": -45875629.918284796, "element": 38637135.10683766 }, "errorHandler": { "actor": "Pronghorn", "groups": [ "default", "default" ], "iterations": [ "e15Ea88a-3619-4a40-4421-bD37FfcC1DA8", "5A6234D9-3CdD-eDCB-BBce-0bC0eA8dc50F", "90099B2A-8E7F-d5d0-2dE5-F7acbabAfd08", "9Fb22Bdb-31Dd-9feF-0E3B-E3E1B4F80AEd" ], "x": 37683033.87165713, "y": -17007463.896805853, "gridCoordinate": { "x": -4880288.381792262, "y": -77589282.5326407 }, "name": "commodo aliqua magna", "location": "Broker", "locationType": null, "app": "incididunt nulla in velit", "canvasName": "childJob", "displayName": "eu", "summary": "enim exercitation", "description": "sit sed", "variables": { "error": "", "decorators": [ { "type": "encryption", "pointer": "/~0/~1/fInwG/~1/hSB-szH/~1/~0/V-s8/~1" } ] }, "deprecated": true, "scheduled": false, "matched": [ { "key": "nulla ad", "highlightString": "in anim veniam" }, { "key": "Duis", "highlightString": "enim qui sunt ea" }, { "key": "magna", "highlightString": "ad" } ], "status": "paused", "previous": { "incomplete": [ "e28f" ], "complete": [ "workflow_end", "3a1f", "workflow_start", "error_handler", "workflow_start" ], "error": [ "workflow_start" ] }, "taskId": "e28f", "transitions": { "success": [ { "task": "3a1f", "type": "revert" }, { "task": "workflow_start", "type": "loop" }, { "task": "e28f", "type": "standard" }, { "task": "workflow_end", "type": "revert" }, { "task": "3a1f", "type": "standard" } ], "failure": [ { "task": "error_handler", "type": "standard" } ], "error": [ { "task": "workflow_start", "type": "loop" } ] }, "serverId": "sed ut", "start_time": "1963-12-17T08:40:56.848Z", "end_time": -46265809.48237042, "finish_state": "success", "retrySettings": null, "loop": { "atLeastOneComplete": true, "finishedCount": -99936275.40020627, "outgoing": [ "adipisicing anim", "reprehenderit minim labore irure", null ] }, "childJobs": [ { "_id": "magna culpa officia", "name": "in eiusmod Ut consequat id", "iteration": 37129050.22277272 }, { "_id": "irure in adipisicing in nulla", "name": "anim", "iteration": 71612459.35272321 }, { "_id": "nisi id fugiat", "name": "ipsum consectetur magna sunt", "iteration": 56771737.60733497 }, { "_id": "qui enim amet", "name": "adipisicing mollit elit", "iteration": 55270979.756652266 } ] }, "groups": [ "79282d60ee57228ad8b39a90", { "_id": "804c5c2b4415a9bca0004176", "provenance": "exercitation proident mollit occaecat", "name": "ut ea", "description": "est consequat tempor sed", "memberOf": [ { "groupId": "b5ee4b2984f95dfbfedb0941", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "ea enim Ut" }, { "roleId": "deserunt qui quis in" } ], "inactive": true, "_meta": { "created": "1982-11-05T22:13:27.392Z", "updated": "2005-02-18T10:50:58.78Z", "migrationVersion": -78011164 } } ], "watchers": [ "Pronghorn", { "_id": "ccac3788a5c84e784424d7d4", "provenance": "laborum amet et voluptate adipisicing", "username": "officia ullamco elit non laborum", "firstname": "tempor magna proident cupidatat ut", "memberOf": [ { "groupId": "82281d59dfdac0fb2cd1d03f", "aaaManaged": false }, { "groupId": "3abeb10c726b053d322091bd", "aaaManaged": true }, { "groupId": "1d80c1499737f68ffd896904", "aaaManaged": true }, { "groupId": "14f42ab8047e1364a694eedb", "aaaManaged": false }, { "groupId": "70520fed87bf2922dd99d5d2", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "fugiat sunt adipisicing" }, { "roleId": "non" }, { "roleId": "adipisicing esse consequat dolor laboris" }, { "roleId": "consequat laborum" } ], "inactive": true, "lastLogin": "2016-04-29T07:19:53.166Z", "_meta": { "created": "1995-04-09T18:58:04.341Z", "updated": "1974-10-04T22:34:28.695Z", "migrationVersion": 48497808 }, "email": "dolor minim ad" }, "1b95c00ed2d091e0c9231a60" ], "metrics": { "start_time": -34117025.99954363, "progress": 0.7123186634997791, "end_time": 37411500.077533334, "user": "Pronghorn", "owner": "8fa24c4db7c187e75e2aeb6d" } } }
{ "title": "job", "allOf": [ { "$ref": "common-api#/definitions/success-response" }, { "type": "object", "properties": { "data": { "$ref": "job-api" } } } ] }