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": "description", "exclude": "_id", "dereference": "accounts.createdBy" } }
{ "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 created the requested item", "data": { "_id": "6ec21170413be238b1b48457", "font_size": 81791300, "type": "resource:action", "created": "1981-06-03T11:37:32.987Z", "last_updated": "1957-05-19T12:16:52.37Z", "createdVersion": "2978909415.198.54", "lastUpdatedVersion": "0328761189.2128.3271549128-9776.61.9.1", "canvasVersion": 1.5, "encodingVersion": 1, "migrationVersion": 87808625, "name": "myCoolDocumentName", "description": null, "preAutomationTime": 8677589.701034501, "sla": -50665499.890577294, "decorators": [ { "type": "encryption", "pointer": "/f5vE/~0" }, { "type": "encryption", "pointer": "/~1/AQeuWYkL+//~0/I6y-XX/~0/zr13z/gVb91OU4/d-vX4/OQDootsLy" }, { "type": "encryption", "pointer": "/~0/I0DAO/~0/~0/ddEFs/~1/l/~1/ZnFmf" } ], "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 } ], "warnings": [ { "task": "error_handler", "name": "myCoolDocumentName", "message": "commodo in pariatur nisi" }, { "task": "workflow_end", "name": "myCoolDocumentName", "message": "elit fugiat Excepteur nostrud velit" }, { "task": "workflow_start", "name": "myCoolDocumentName", "message": "ut culpa" }, { "task": "workflow_end", "name": "myCoolDocumentName", "message": "ex in tempor enim labore" } ], "ancestors": null, "validationErrors": [ { "keyword": "officia eu enim consequat sed", "dataPath": "occaecat", "schemaPath": "et Excepteur ut sit", "message": "adipisicing reprehenderit" } ], "created_by": "b6e2d11b1392ade23bf27e98", "last_updated_by": "88221b691e5e626b5f1f5b35", "tasks": { "workflow_start": { "x": -93604662.19097815, "y": -29979141.503367886, "gridCoordinate": { "x": 83734434.20180684, "y": -5522131.691746786 }, "name": "workflow_start", "summary": "workflow_start", "taskId": "workflow_start", "metrics": { "start_time": 36224462.226831466, "finish_state": "error", "user": "Pronghorn" }, "groups": [ "default", "default", "default", { "_id": "dfd39593b604ced77f2abe8d", "provenance": "in proident magna nostrud", "name": "cupidatat", "description": "commodo et aute Duis", "memberOf": [ { "groupId": "5329f312a2b587f5241d4f77", "aaaManaged": true }, { "groupId": "71c801c8f8c3e42731be2687", "aaaManaged": false }, { "groupId": "1c7fcd1358e91b5c3ef9a787", "aaaManaged": false }, { "groupId": "f9061a2f22eb7a3c470b9af5", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "in" }, { "roleId": "aliqua magna amet ut fugiat" }, { "roleId": "veniam" } ], "inactive": true, "_meta": { "created": "2008-04-16T02:28:21.376Z", "updated": "1967-06-30T12:36:01.625Z", "migrationVersion": -82430612 } }, { "_id": "36bba4b3f4ac867531a2f626", "provenance": "irure magna quis incididunt culpa", "name": "quis ipsum", "description": "quis amet dolor sed est", "memberOf": [ { "groupId": "cf744a12f867923ecd6be31d", "aaaManaged": true }, { "groupId": "ce8b4765200de58a333392e9", "aaaManaged": true }, { "groupId": "34adef0465e5c4939385cb8c", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "Excepteur veniam esse" }, { "roleId": "ut sit in" }, { "roleId": "ullamco dolore nulla eu cillum" }, { "roleId": "culpa eu ullamco" } ], "inactive": true, "_meta": { "created": "1964-12-10T12:08:51.644Z", "updated": "1948-07-16T10:45:05.562Z", "migrationVersion": 68099926 } } ], "iterations": [ "3Cd89d4E-1282-2013-6E47-50E8aba3DeDB" ] }, "workflow_end": { "x": -34484192.37252169, "y": 62092628.52779108, "gridCoordinate": { "x": 89726510.20008233, "y": 96521424.9102664 }, "name": "workflow_end", "summary": "workflow_end", "taskId": "workflow_end", "endTasks": { "incomplete": [ "error_handler", "workflow_start", "3a1f", "error_handler" ], "complete": [ "workflow_start", "error_handler", "3a1f" ], "error": [ "error_handler", "e28f" ] }, "metrics": { "end_time": 62588644.61366907, "run_time": 47236096.80989313 }, "groups": [ { "_id": "1aa02d8fc1540dce0eb01132", "provenance": "velit nostrud laboris Ut", "name": "in sunt", "description": "in tempor cillum proident elit", "memberOf": [ { "groupId": "ab507784e77dc1f740fc03e3", "aaaManaged": false }, { "groupId": "09db76afac1890ef3cb25698", "aaaManaged": true }, { "groupId": "c57a457576196095cf51f62a", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "sit proident" }, { "roleId": "quis ipsum" }, { "roleId": "mollit sit exercitation eiusmod" }, { "roleId": "qui laborum" } ], "inactive": false, "_meta": { "created": "1982-03-11T00:04:45.781Z", "updated": "1948-06-22T22:36:40.409Z", "migrationVersion": -91030706 } }, "a986d9e7a3857bbef9b0d42b", "default" ], "iterations": [ "D3baAbFf-C1cf-7f85-13aB-6fDddEbbFa62" ] }, "error_handler": { "x": -47210926.6947204, "y": 65296694.968444824, "gridCoordinate": { "x": 75471512.56532508, "y": -85811046.27474487 }, "name": "childJob", "location": "Application", "locationType": "mollit cillum adipisicing deserunt Duis", "app": "nisi dolor Ut qui", "canvasName": "sunt veniam cupidatat occaecat", "displayName": "velit Ut", "summary": "sit mollit", "description": "eiusmod ipsum officia amet in", "variables": { "error": "", "decorators": [ { "type": "encryption", "pointer": "/Gvn9JXd/~0/~1/~1/~1/~1" } ] }, "deprecated": true, "scheduled": false, "matched": [ { "key": "magna velit ipsum commodo", "highlightString": "dolor quis" }, { "key": "Lorem ad sint tempor", "highlightString": "laboris aute ex" }, { "key": "pariatur", "highlightString": "ad sed in" } ], "status": "incomplete", "previous": { "incomplete": [ "workflow_end" ], "complete": [ "error_handler", "e28f", "error_handler", "workflow_start" ], "error": [ "e28f" ] }, "taskId": "workflow_start", "transitions": { "success": [ { "task": "e28f", "type": "loop" }, { "task": "workflow_end", "type": "revert" }, { "task": "3a1f", "type": "standard" }, { "task": "e28f", "type": "loop" } ], "failure": [ { "task": "workflow_end", "type": "loop" } ], "error": [ { "task": "3a1f", "type": "revert" }, { "task": "workflow_start", "type": "loop" } ] }, "serverId": "labore laborum elit esse qui", "start_time": "2004-02-17T09:58:18.934Z", "end_time": -9187361.387700051, "finish_state": "success", "retrySettings": { "state": [ "success", "failure", "failure" ], "autoRetry": false, "limit": 91443495, "delay": 30541417, "count": 4170580, "finishedRetrying": false }, "type": "operation", "actor": null, "groups": [ { "_id": "b67bf3e6806d317c87341201", "provenance": "consectetur et", "name": "enim eu", "description": "in est nisi do pariatur", "memberOf": [ { "groupId": "d1f1b6d0a9d642a7661559e6", "aaaManaged": false }, { "groupId": "630258c388135340bf6914b4", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "dolore incididunt id magna Ut" }, { "roleId": "reprehenderit adipisicing" }, { "roleId": "proident" }, { "roleId": "in consequat et ea dolore" }, { "roleId": "et" } ], "inactive": false, "_meta": { "created": "1963-09-27T08:41:46.065Z", "updated": "2018-02-05T22:02:30.229Z", "migrationVersion": 25377834 } }, "b02f13e03cade257d381124e" ], "iterations": [ "EBd7BbEa-1cDb-bCEC-fa8D-d4EaC5b0cc5D", "bc86ece8-4CCb-18b8-6cBd-0a6eafCDeA2a" ] }, "f1c2": { "actor": "job", "groups": [ "default", { "_id": "295bbb5a6a991b9cc719315b", "provenance": "sint ex exercitation commodo", "name": "ullamco in exercitation", "description": "enim in", "memberOf": [ { "groupId": "1246320d902e4a1d9f22038e", "aaaManaged": false }, { "groupId": "343726fc47ab13a26938987e", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "est ut" }, { "roleId": "velit reprehenderit dolor voluptate consequat" }, { "roleId": "enim do non" }, { "roleId": "in Excepteur esse officia" }, { "roleId": "occaecat fugiat" } ], "inactive": true, "_meta": { "created": "1988-10-21T01:03:12.642Z", "updated": "2023-12-12T17:35:31.811Z", "migrationVersion": 68152563 } }, { "_id": "3dab7d366b68d8f8524d6893", "provenance": "laborum anim nulla occaecat", "name": "ex id", "description": "qui ex minim pariatur", "memberOf": [ { "groupId": "a2f1fe1aae8126797f12d9dd", "aaaManaged": false }, { "groupId": "1b1335733c4f9c869fe72d7b", "aaaManaged": false }, { "groupId": "4fafde1acbb3292f57ee17cc", "aaaManaged": true }, { "groupId": "ff0b39f8c8799a8db24662c7", "aaaManaged": false }, { "groupId": "0ec8a82b468577c53fc9c0e9", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "ea" } ], "inactive": true, "_meta": { "created": "1988-10-03T09:12:38.403Z", "updated": "1968-05-23T06:32:29.735Z", "migrationVersion": -91518813 } }, "63a31f0ec461649048b315f3" ], "iterations": [ "919accDB-46a7-20CF-eB78-a4a80011fde9", "Cff9b981-3932-6FBa-DD8D-Ab5c75db1a8B" ], "x": -82803737.61347617, "y": 43956680.20060253, "gridCoordinate": { "x": 88608036.85794568, "y": -93467099.65895595 }, "name": "consectetur quis labore proident irure", "location": "Application", "locationType": "ipsum nostrud incididunt", "app": "labore nulla nisi", "canvasName": "do qui", "displayName": "anim ut", "summary": "adipisicing anim", "description": "ut non", "variables": { "error": "", "decorators": [ { "type": "encryption", "pointer": "/~0/R/Pr8/~0/~1/~1/~0" } ] }, "deprecated": false, "scheduled": false, "matched": [ { "key": "nulla", "highlightString": "nulla do Excepteur commodo" }, { "key": "Duis", "highlightString": "aliqua culpa cillum" } ], "status": "complete", "previous": { "incomplete": [ "error_handler", "workflow_end", "e28f" ], "complete": [ "workflow_end" ], "error": [ "workflow_start", "workflow_end" ] }, "taskId": "workflow_start", "transitions": { "success": [ { "task": "error_handler", "type": "revert" }, { "task": "e28f", "type": "revert" }, { "task": "e28f", "type": "loop" }, { "task": "workflow_start", "type": "loop" }, { "task": "workflow_end", "type": "revert" } ], "failure": [ { "task": "error_handler", "type": "revert" }, { "task": "workflow_start", "type": "loop" }, { "task": "e28f", "type": "revert" }, { "task": "error_handler", "type": "standard" } ], "error": [ { "task": "workflow_start", "type": "standard" }, { "task": "workflow_end", "type": "loop" }, { "task": "workflow_start", "type": "loop" }, { "task": "error_handler", "type": "revert" } ] }, "serverId": "laboris", "start_time": "1966-01-17T19:32:38.348Z", "end_time": -21504488.573204353, "finish_state": "failure", "retrySettings": { "state": [ "error" ], "autoRetry": false, "limit": 61453351, "delay": 61638037, "count": 17388906, "finishedRetrying": true }, "type": "automatic" } }, "parent": { "task": "eu reprehenderit dolore", "iteration": 447034.83182905614, "element": 69579192.2766357 }, "errorHandler": { "actor": "$var.job.q_I", "groups": [ { "_id": "468a1ff52951ad5d6cc82b89", "provenance": "ea aliqua", "name": "eiusmod consequat consectetur in", "description": "consequat in irure occaecat id", "memberOf": [ { "groupId": "5237de0dd863af7acc64c666", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "ex labore qui ipsum" }, { "roleId": "est" }, { "roleId": "ad mollit quis dolore officia" }, { "roleId": "qui culpa pariatur" } ], "inactive": false, "_meta": { "created": "1982-07-24T00:18:24.377Z", "updated": "2006-02-03T09:32:31.715Z", "migrationVersion": 28678785 } }, "234eac83d1e89ff40bd42de5", "38bbdb868f654258305cbae8", "57c3b6152f50881298f0de1a", "default" ], "iterations": [ "9dEEB84B-5c90-f2fE-eE11-810FF1d3fdEC" ], "x": -29860397.94296427, "y": -90943865.48057014, "gridCoordinate": { "x": 4124219.102101505, "y": -30643855.619835228 }, "name": "velit irure qui in aute", "location": "Broker", "locationType": "dolor", "app": "nisi", "canvasName": "Ut id et Excepteur", "displayName": "amet", "summary": "in", "description": "minim elit Ut dolor ea", "variables": { "error": "", "decorators": [ { "type": "encryption", "pointer": "/ZQKr/~0/~1/~0/z0M/~0/EkJ7lxu/~0/~1/~1/~1" }, { "type": "encryption", "pointer": "/G9/SJLfa/Hr/wVP6/08Uaj7/RNYyVvu/~0/~1/~0/hVNLZS2TWGR/~1/UygqfiXR" } ] }, "deprecated": false, "scheduled": true, "matched": [ { "key": "Ut pariatur aliquip Duis", "highlightString": "sit fugiat" }, { "key": "occaecat laborum ea voluptate", "highlightString": "exercitation ut enim" }, { "key": "ea ut", "highlightString": "proident mollit in minim" }, { "key": "sunt ex fugiat eiusmod", "highlightString": "sint enim commodo tempor" } ], "status": "scheduled", "previous": { "incomplete": [ "e28f", "error_handler", "workflow_start", "workflow_end" ], "complete": [ "workflow_end", "error_handler" ], "error": [ "workflow_start", "e28f" ] }, "taskId": "error_handler", "transitions": { "success": [ { "task": "workflow_start", "type": "standard" }, { "task": "workflow_end", "type": "standard" }, { "task": "workflow_start", "type": "loop" }, { "task": "workflow_end", "type": "revert" } ], "failure": [ { "task": "3a1f", "type": "standard" } ], "error": [ { "task": "3a1f", "type": "loop" }, { "task": "workflow_start", "type": "standard" }, { "task": "error_handler", "type": "loop" }, { "task": "3a1f", "type": "standard" } ] }, "serverId": "incididunt cupidatat", "start_time": "1955-01-18T20:32:35.565Z", "end_time": 80186970.91443542, "finish_state": "failure", "retrySettings": null, "type": "automatic" }, "groups": [ "a0f4e34fe9aa123d10e8ab01", "default" ], "watchers": [ "dc5525ca3a11eafa7142d680", "Pronghorn", "Pronghorn" ], "metrics": { "start_time": -79326731.01422244, "progress": 0.5428625329228005, "end_time": -11484768.822314888, "user": null, "owner": null } } }
{ "title": "job", "allOf": [ { "$ref": "common-api#/definitions/success-response" }, { "type": "object", "properties": { "data": { "$ref": "job-api" } } } ] }