Summary
Get a Job
Description
Get a Job.
Route
GET /operations-manager/jobs/:id
Roles
Parameters
Name | Type | Required | Description |
---|---|---|---|
id | string | yes | The id of the Job to get. |
queryParameters | object | yes | Optional parameters for projecting fields in the Job document. |
{ "queryParameters": { "include": "name,description", "exclude": "_id,description", "dereference": "tasks" } }
{ "type": "object", "properties": { "queryParameters": { "title": "queryParameters", "type": "object", "properties": { "include": { "type": "string", "description": "Inclusive projection operator formatted as a comma-delineated list. '_id' will be included implicitly unless excluded with 'exclude=_id'. May only be used in conjunction with 'exclude' when 'exclude=_id'.", "examples": [ "name", "description", "name,description" ] }, "exclude": { "type": "string", "description": "Exclusive projection operator formatted as a comma-delineated list. May only be used in conjunction with 'include' when 'exclude=_id'.", "examples": [ "_id", "description", "_id,description" ] }, "dereference": { "type": "string", "description": "Designates foreign key fields to dereference in the API output.", "examples": [ "tasks", "accounts.createdBy" ] } } } }, "required": [ "queryParameters" ], "additionalProperties": false }
Return
Name | Type | Description |
---|---|---|
job | object | The requested Job. |
{ "message": "Successfully retrieved search results", "data": { "_id": "a6a34247096c23d7c3ca9a3e", "font_size": 65565602, "type": "automation", "created": "1994-03-16T16:06:27.668Z", "last_updated": "1988-09-08T10:58:01.629Z", "createdVersion": "23308.55616531874.6752321800-6086.25036083.2776.93403", "lastUpdatedVersion": "4414084.5056604.3327596", "canvasVersion": 1, "encodingVersion": 1, "migrationVersion": 65290905, "name": "myCoolDocumentName", "description": "Some helpful information about the document", "preAutomationTime": -26499816.811811432, "sla": 14784420.290963322, "decorators": [ { "type": "encryption", "pointer": "/~1/~1/~0" } ], "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": "workflow_start", "name": "myCoolDocumentName" }, { "task": "3a1f", "name": "myCoolDocumentName" }, { "task": "error_handler", "name": "myCoolDocumentName" }, { "task": "workflow_start", "name": "myCoolDocumentName" } ], "ancestors": [ "d150ea8f3b424496d5678e91", "c1b592016b5ef8cf2647930e", "9bc227206f9863c8d4ca2ed0", "bdafa993c524b587ee520151" ], "validationErrors": [ { "keyword": "in do", "instancePath": "reprehenderit id ut", "schemaPath": "do", "message": "deserunt" }, { "keyword": "cillum eu pariatur dolor", "instancePath": "Lorem aliquip eiusmod velit incididunt", "schemaPath": "dolor sit mollit amet", "message": "sed id nostrud aliquip consequat" } ], "created_by": "Pronghorn", "last_updated_by": null, "tasks": { "workflow_start": { "x": 48396259.02593988, "y": -55486224.58699732, "gridCoordinate": { "x": 89856592.97411016, "y": 70062723.91465944 }, "name": "workflow_start", "summary": "workflow_start", "taskId": "workflow_start", "metrics": { "start_time": 6933181.484310776, "finish_state": "success", "user": { "_id": "e53e4f1b0f7a8d4f0eaf5ec7", "provenance": "culpa sint aliqua laborum", "username": "aliqua est sint", "firstname": "laborum deserunt", "memberOf": [ { "groupId": "886e78e1eee85a65e6e8e6b6", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "irure ut ex Lorem" }, { "roleId": "ut aliqua Duis Lorem" }, { "roleId": "occaecat eiusmod incididunt consectetur laboris" } ], "inactive": true, "lastLogin": "1989-12-18T19:13:57.691Z", "_meta": { "created": "1958-11-11T07:51:27.667Z", "updated": "1950-02-26T13:20:42.011Z", "migrationVersion": 49164500 }, "email": "ut" } }, "groups": [ "573495544f8761fbb3123e0c", { "_id": "b467679484db5de909d2d249", "provenance": "in sint eiusmod", "name": "commodo", "description": "nisi pariatur sed mollit", "memberOf": [ { "groupId": "8a94b70c2d43bcbbdde4233c", "aaaManaged": true }, { "groupId": "914d9d9f87983ec6eec8bf5a", "aaaManaged": false }, { "groupId": "2bc2ae5b78ead3f790141bc4", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "sunt" }, { "roleId": "reprehenderit" }, { "roleId": "culpa exercitation fugiat ea sit" }, { "roleId": "labore sint" }, { "roleId": "adipisicing anim" } ], "inactive": true, "_meta": { "created": "1986-05-19T01:41:26.834Z", "updated": "1993-05-25T01:50:33.826Z", "migrationVersion": 77288604 } }, "default", "6228f04f3bbec2c77dbeae3e", "4d81e146391a029a388c5aec" ], "iterations": [] }, "workflow_end": { "x": -88282710.68669368, "y": -76098008.70597163, "gridCoordinate": { "x": 90378077.9400194, "y": 76748493.01848522 }, "name": "workflow_end", "summary": "workflow_end", "taskId": "workflow_end", "endTasks": { "incomplete": [ "workflow_start", "3a1f", "error_handler", "workflow_end", "workflow_end" ], "complete": [ "e28f", "workflow_end", "3a1f", "3a1f", "workflow_start" ], "error": [ "workflow_end", "workflow_start", "3a1f", "e28f" ] }, "metrics": { "end_time": -44602885.94443149, "run_time": 4743221.542957604 }, "groups": [ { "_id": "07434237dd5daccf24dda845", "provenance": "voluptate aliqua dolor", "name": "Duis ex magna", "description": "laborum id magna ut", "memberOf": [ { "groupId": "af7e395235f49d5ca7bc826f", "aaaManaged": false }, { "groupId": "ad452420ee1d890b34c71f6d", "aaaManaged": true }, { "groupId": "093c39760a38b11ebbcd56c4", "aaaManaged": true }, { "groupId": "169893e2f84f18aab075e759", "aaaManaged": false }, { "groupId": "8585654daca07eb7f91ec11d", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "ex" }, { "roleId": "laboris ut cillum" }, { "roleId": "ipsum veniam pariatur consectetur deserunt" } ], "inactive": true, "_meta": { "created": "1972-04-02T16:00:45.505Z", "updated": "2011-11-24T02:17:00.239Z", "migrationVersion": 74364624 } } ], "iterations": [] }, "error_handler": { "x": 19884047.437158525, "y": 48160572.7588509, "gridCoordinate": { "x": -36919390.81165394, "y": 78164091.08483616 }, "name": "childJob", "location": "Broker", "locationType": "sint eu sed culpa", "app": "sunt", "canvasName": "voluptate reprehenderit dolore", "displayName": "ut pariatur elit ipsum", "summary": "sunt elit consequat Lorem", "description": "adipisicing in nisi", "variables": { "error": "", "decorators": [ { "type": "encryption", "pointer": "/~0" }, { "type": "encryption", "pointer": "/pdMFn" } ] }, "deprecated": false, "scheduled": true, "matched": [ { "key": "fugiat ea amet", "highlightString": "Duis dolore quis pariatur" }, { "key": "in dolore", "highlightString": "Lorem" } ], "status": "incomplete", "previous": { "incomplete": [ "workflow_start", "3a1f" ], "complete": [ "workflow_end", "workflow_end", "workflow_end" ], "error": [ "workflow_end", "workflow_start", "3a1f" ] }, "taskId": "workflow_end", "transitions": { "success": [ { "task": "workflow_start", "type": "standard" }, { "task": "workflow_start", "type": "standard" }, { "task": "workflow_start", "type": "revert" } ], "failure": [ { "task": "error_handler", "type": "revert" } ], "error": [ { "task": "workflow_end", "type": "standard" } ] }, "serverId": "non mollit", "start_time": "2013-06-01T21:53:43.169Z", "end_time": 30144579.474170327, "finish_state": "error", "retrySettings": null, "type": "operation", "actor": "job", "groups": [ { "_id": "71f279ab68ddaba78fdc166e", "provenance": "sit veniam cupidatat", "name": "irure ut dolor aliquip", "description": "dolor quis", "memberOf": [ { "groupId": "67a872eeaf64522f9a3bbb60", "aaaManaged": true }, { "groupId": "e764dca270a0c2300f39689e", "aaaManaged": true }, { "groupId": "26b47bd60c0e2b4faa67df3b", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "in in" } ], "inactive": true, "_meta": { "created": "2008-03-21T09:56:51.83Z", "updated": "1988-01-10T16:08:37.655Z", "migrationVersion": 59643874 } }, "d106f4443be0a1bb44845c2b", { "_id": "64166406626a73ec0e92405e", "provenance": "ut consectetur deserunt esse", "name": "exercitation dolor nostrud id", "description": "in", "memberOf": [ { "groupId": "79903bbc33ef548ea7ed43b5", "aaaManaged": false }, { "groupId": "33e4edf9393967d2fbb90512", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "dolor tempor culpa" }, { "roleId": "deserunt tempor ut nulla cillum" }, { "roleId": "cupidatat" } ], "inactive": true, "_meta": { "created": "1973-04-19T14:03:12.186Z", "updated": "2009-06-28T23:34:38.521Z", "migrationVersion": 58881623 } }, "d58b878bca5c456cbddf8b22", "default" ], "iterations": [ "b33C8207-C0B0-B755-Cc2C-7F25B08431B9", "7fDFfAfC-edB5-490D-7bc8-85f06fAb0B18", "D94eb8A1-E0E6-f0C4-fAfb-ebCfb61E030B" ] }, "6b": { "x": 88453805.58927593, "y": -78536818.54126182, "gridCoordinate": { "x": -75088594.2073782, "y": 10180547.20739156 }, "name": "Lorem aliquip", "location": "Broker", "locationType": null, "app": "dolore occaecat pariatur", "canvasName": "consequat mollit deserunt", "displayName": "velit in", "summary": "labore", "description": "quis dolore", "variables": { "error": "", "decorators": [ { "type": "encryption", "pointer": "/~1/~1" }, { "type": "encryption", "pointer": "/~1/hvifm+BN/qrMWLWSp7J/~0/W5hEXs//pdly/CroIKgj" }, { "type": "encryption", "pointer": "/~0/~1/ejXd3gxj75//Ly,/~0/JSGZin/e+GXYK/~1" } ] }, "deprecated": true, "scheduled": false, "matched": [ { "key": "sint proident cupidatat", "highlightString": "Ut" } ], "status": "complete", "previous": { "incomplete": [ "workflow_start" ], "complete": [ "workflow_end" ], "error": [ "e28f", "workflow_start", "3a1f", "workflow_start", "workflow_start" ] }, "taskId": "workflow_end", "transitions": { "success": [ { "task": "3a1f", "type": "revert" }, { "task": "workflow_start", "type": "revert" }, { "task": "error_handler", "type": "revert" }, { "task": "workflow_start", "type": "loop" }, { "task": "workflow_start", "type": "revert" } ], "failure": [ { "task": "3a1f", "type": "loop" }, { "task": "3a1f", "type": "revert" }, { "task": "e28f", "type": "standard" }, { "task": "workflow_start", "type": "revert" }, { "task": "workflow_start", "type": "loop" } ], "error": [ { "task": "e28f", "type": "loop" }, { "task": "workflow_start", "type": "loop" }, { "task": "3a1f", "type": "revert" }, { "task": "workflow_end", "type": "loop" }, { "task": "e28f", "type": "loop" } ] }, "serverId": "eu fugiat in", "start_time": "1993-06-22T09:24:13.936Z", "end_time": 7069417.070684865, "finish_state": "failure", "retrySettings": { "state": [ "success" ], "autoRetry": false, "limit": 15229156, "delay": 8875799, "count": 19266542, "finishedRetrying": false }, "type": "operation", "actor": "job", "groups": [ "1f4b33c9a9c41af175c8abbd" ], "iterations": [ "1Eee307D-D5fC-aC24-d0CB-72e97FdFd4CB", "dE4ba984-e538-8c6b-Bdd9-480Fe1DA60c4" ] } }, "parent": { "job": "irure", "task": "esse laboris ut proident", "iteration": -68149415.14241739, "element": 17037836.392185703 }, "errorHandler": { "x": -71690042.13457698, "y": 68652550.55589604, "gridCoordinate": { "x": -53755909.0173616, "y": 75290273.29552314 }, "name": "aliquip", "location": "Application", "locationType": null, "app": "irure nostrud tempor", "canvasName": "adipisicing dolore Duis", "displayName": "occaecat", "summary": "esse dolor", "description": "incididunt non Ut labore", "variables": { "error": "", "decorators": [ { "type": "encryption", "pointer": "/~1/~1/Uv/jripy/W5Xue+TI/zkTUhwp58/r/~0/~0/dWI8Ls/~0" }, { "type": "encryption", "pointer": "/X2cUPlEps7/b200/~1/E/~1/~1/~1/~0/~0/~1/Jy,s" }, { "type": "encryption", "pointer": "/~1/~0/~0/uw/JF5SQUI5/~0/i6IHlSCvPEm" }, { "type": "encryption", "pointer": "/~0/~1/Iu/V/aRT1q4fs/~0/~1/BNX0/QJSYwOnb/E8q/~1" } ] }, "deprecated": false, "scheduled": true, "matched": [ { "key": "culpa Duis dolor", "highlightString": "laborum aliquip voluptate elit" }, { "key": "tempor id dolor", "highlightString": "elit laborum nostrud ut quis" }, { "key": "sed elit nulla laborum velit", "highlightString": "est qui sed eiusmod nulla" }, { "key": "quis deserunt esse ex aliquip", "highlightString": "nisi nulla in" } ], "status": "running", "previous": { "incomplete": [ "e28f" ], "complete": [ "workflow_start", "e28f", "workflow_start", "3a1f", "e28f" ], "error": [ "e28f", "workflow_start", "3a1f", "workflow_end", "workflow_start" ] }, "taskId": "workflow_end", "transitions": { "success": [ { "task": "error_handler", "type": "loop" } ], "failure": [ { "task": "error_handler", "type": "loop" }, { "task": "workflow_end", "type": "standard" }, { "task": "workflow_start", "type": "loop" }, { "task": "workflow_start", "type": "loop" } ], "error": [ { "task": "error_handler", "type": "revert" } ] }, "serverId": "elit tempor officia enim quis", "start_time": "2011-12-10T20:56:06.132Z", "end_time": -82809328.85063761, "finish_state": "failure", "retrySettings": null, "type": "operation", "actor": null, "groups": [ "default", "default", "default" ], "iterations": [ "0AeF615e-12CB-c8Ec-e7cf-f07EcFBE3514" ] }, "groups": [ "618d87786d438c1c945e1a0d", "default", { "_id": "382bf3f85f7d5b3dd4c96285", "provenance": "voluptate", "name": "elit occaecat", "description": "minim", "memberOf": [ { "groupId": "cdac6c6814b29ba6b08c0d8f", "aaaManaged": true }, { "groupId": "9631d192bc33dc1e66af54fc", "aaaManaged": true }, { "groupId": "dec6d736bc4628ceb37ef199", "aaaManaged": false }, { "groupId": "eae5437114b15da9545933a1", "aaaManaged": true }, { "groupId": "d4a17f4a1ad74c133adcfa44", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "tempor Duis anim" }, { "roleId": "nulla eiusmod dolore consequat anim" }, { "roleId": "Duis Lorem dolore quis" }, { "roleId": "aliquip aliqua" }, { "roleId": "tempor deserunt veniam ut adipisicing" } ], "inactive": true, "_meta": { "created": "1985-05-08T13:20:35.272Z", "updated": "1972-04-13T16:31:15.774Z", "migrationVersion": -69181840 } }, "98846a3fb9c8cdde9d2e37b2", "f2bcab52b95371c58661e77c" ], "watchers": [ "6e80c10482e225a4fc798b41" ], "metrics": { "start_time": -36819631.893171236, "progress": 0.40686722481169624, "end_time": 47947395.85712096, "user": "Pronghorn", "owner": "Pronghorn" } } }
{ "title": "job", "allOf": [ { "$ref": "common-api#/definitions/success-response" }, { "type": "object", "properties": { "data": { "$ref": "job-api" } } } ] }