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 imported 3 of 4 documents", "data": { "_id": "f7787c01bf77021a6efa898d", "uuid": "1b53a205-9799-5643-ec84-8d70c468ceba", "font_size": 64747567, "type": "resource:compliance", "created": "2009-01-29T14:50:03.087Z", "last_updated": "1979-11-07T00:29:41.717Z", "createdVersion": "43.99912655761.886786-2053.06.784.68281", "lastUpdatedVersion": "79381.384602694.567148", "canvasVersion": 3, "encodingVersion": 1, "migrationVersion": 89555047, "name": "myCoolDocumentName", "description": null, "preAutomationTime": -81045691.03823116, "sla": -70460879.74588251, "decorators": [ { "type": "encryption", "pointer": "/~1/bJc/gx/W7ErByzFTV" }, { "type": "encryption", "pointer": "/~1/~1/b-H0F/~0/Z46Uxp9FZv" } ], "status": "paused", "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 } ], "warnings": [ { "task": "workflow_start", "name": "myCoolDocumentName", "message": "aute irure esse commodo" }, { "task": "error_handler", "name": "myCoolDocumentName", "message": "consectetur sed elit enim qui" } ], "ancestors": null, "validationErrors": [ { "keyword": "sed qui est nulla sint", "instancePath": "et amet voluptate ex", "schemaPath": "non incididunt eu", "message": "laboris" } ], "created_by": { "_id": "f40c884fcacc87c0b16b5337", "provenance": "in ex fugiat nulla do", "username": "irure id dolore", "firstname": "incididunt dolore proident", "memberOf": [ { "groupId": "8260fa9b03741c120e66e89a", "aaaManaged": false }, { "groupId": "32cacd9cce540540834bd6ac", "aaaManaged": false }, { "groupId": "cc15408327dbcf02988c96fb", "aaaManaged": false }, { "groupId": "0eed8901358889852644dd75", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "esse non fugiat" }, { "roleId": "esse officia" }, { "roleId": "Excepteur ut deserunt veniam ut" } ], "inactive": true, "lastLogin": "2008-09-11T18:30:46.382Z", "_meta": { "created": "1998-11-03T05:08:55.899Z", "updated": "2014-04-30T05:23:17.66Z", "migrationVersion": -60492128 }, "email": "proident Duis Ut tempor Excepteur" }, "last_updated_by": { "_id": "dc7665850172578de19ce0bd", "provenance": "officia sit qui sunt", "username": "consectetur aliquip sit", "firstname": "cupidatat incididunt aliquip cillum dolore", "memberOf": [ { "groupId": "222597ac4461ad2e669904b4", "aaaManaged": false }, { "groupId": "aaf7f2bdbe3086358ca9cc98", "aaaManaged": false }, { "groupId": "fa51544e7760cdf214d7d992", "aaaManaged": false }, { "groupId": "f85474ae553c1536a805a6ab", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "quis aliqua" }, { "roleId": "cupidatat reprehenderit do Ut occaecat" }, { "roleId": "id dolore" } ], "inactive": false, "lastLogin": "2007-06-23T07:28:32.978Z", "_meta": { "created": "1987-10-11T02:46:48.96Z", "updated": "1997-07-15T00:30:30.577Z", "migrationVersion": 40676369 }, "email": "deserunt quis" }, "tasks": { "workflow_start": { "x": -52963916.68414882, "y": -12254010.739025742, "gridCoordinate": { "x": -97690350.87012927, "y": -56397190.72827707 }, "name": "workflow_start", "summary": "workflow_start", "taskId": "workflow_start", "metrics": { "start_time": -9950148.825081855, "finish_state": "error", "user": null }, "groups": [ "d835ef44c6ce874b96558b7a", { "_id": "d92b3883d904506df8bd4825", "provenance": "qui laboris nostrud", "name": "consectetur velit eu tempor exercitation", "description": "fugiat adipisicing", "memberOf": [ { "groupId": "fea8c22791dc9b83f2575845", "aaaManaged": true }, { "groupId": "8ea5c163e93fb6c7d765c1d4", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "ut magna" }, { "roleId": "ullamco" }, { "roleId": "mollit occaecat ullamco ad commodo" } ], "inactive": false, "_meta": { "created": "1952-01-19T20:06:37.35Z", "updated": "1958-01-02T15:40:11.994Z", "migrationVersion": 20903842 } } ], "iterations": [ "F50B4f9C-1Fea-648e-DCea-Eb2E634EeCBb", "Bcef022F-0cBf-BdEA-4c8b-5ff55577BF82" ] }, "workflow_end": { "x": -49037012.62702285, "y": 26131054.98183073, "gridCoordinate": { "x": 44159633.80789593, "y": -76889473.00205702 }, "name": "workflow_end", "summary": "workflow_end", "taskId": "workflow_end", "endTasks": { "incomplete": [ "3a1f", "workflow_end", "error_handler", "workflow_start" ], "complete": [ "3a1f", "3a1f", "error_handler", "3a1f" ], "error": [ "e28f", "workflow_end" ] }, "metrics": { "end_time": -91400217.47743519, "run_time": -22185235.528074503 }, "groups": [ "1a29cc315b4c854c949946c6", "127419746c0bf59ca26d9750", "6d236ba3520b4606fa759ba0", "default", { "_id": "17ab1dfbfa181dcc948c1666", "provenance": "mollit sit", "name": "est aute aliquip", "description": "in laboris culpa", "memberOf": [ { "groupId": "d24c97fc43fa09d9d3d443fc", "aaaManaged": true }, { "groupId": "83a0d31441387903964c096f", "aaaManaged": true }, { "groupId": "19d081ff31533cc1c8565396", "aaaManaged": true }, { "groupId": "e2d6d18f655be022bfaddfa7", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "Duis" } ], "inactive": false, "_meta": { "created": "2019-07-09T05:11:04.849Z", "updated": "1981-01-10T14:55:09.886Z", "migrationVersion": 47931699 } } ], "iterations": [ "eCAD8903-58fd-6a9e-a9CE-1fF05ac943E8" ] }, "error_handler": { "x": -15817429.7578682, "y": 38476616.27158949, "gridCoordinate": { "x": -96323894.28451851, "y": 82455599.89376333 }, "name": "childJob", "location": "Application", "locationType": "elit", "app": "anim", "canvasName": "fugiat eu ea ipsum", "displayName": "laboris", "summary": "et ad culpa Duis", "description": "dolore in officia incididunt Excepteur", "variables": { "error": "", "decorators": [ { "type": "encryption", "pointer": "/~0/iN5Nwpr-0Zt/~1/~1/~0/CrpNS.kgG//~1/CVR1m3HvsU/~1/~1/~1" } ] }, "deprecated": true, "scheduled": false, "matched": [ { "key": "cillum", "highlightString": "labore ex" }, { "key": "id consequat esse ut ut", "highlightString": "sit" }, { "key": "sint qui exercitation", "highlightString": "magna irure occaecat" }, { "key": "aliqua", "highlightString": "incididunt dolore mollit Duis" }, { "key": "pariatur ea officia", "highlightString": "minim" } ], "status": "scheduled", "previous": { "incomplete": [ "workflow_start", "e28f", "workflow_end" ], "complete": [ "workflow_start", "workflow_start", "e28f", "workflow_end" ], "error": [ "error_handler", "workflow_end", "workflow_end" ] }, "taskId": "workflow_start", "transitions": { "success": [ { "task": "e28f", "type": "standard" }, { "task": "e28f", "type": "revert" }, { "task": "workflow_end", "type": "revert" }, { "task": "e28f", "type": "revert" } ], "failure": [ { "task": "workflow_start", "type": "standard" }, { "task": "error_handler", "type": "standard" } ], "error": [ { "task": "workflow_start", "type": "loop" }, { "task": "e28f", "type": "standard" }, { "task": "error_handler", "type": "loop" }, { "task": "3a1f", "type": "loop" }, { "task": "error_handler", "type": "standard" } ] }, "serverId": "dolor tempor culpa deserunt", "start_time": "1996-09-26T05:28:04.338Z", "end_time": 60656396.04269487, "finish_state": "error", "retrySettings": { "state": [ "error", "error", "error" ], "autoRetry": false, "limit": 65407529, "delay": 63402964, "count": 6272793, "finishedRetrying": true }, "type": "operation", "actor": "job", "groups": [ "default", { "_id": "e141df5f95fbb11fbb6d953d", "provenance": "mollit sint in", "name": "dolor", "description": "qui", "memberOf": [ { "groupId": "09d6cbea7815c2b91015065e", "aaaManaged": false }, { "groupId": "3a701c6b241df855f1c757e0", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "tempor culpa" }, { "roleId": "Excepteur ipsum ad" }, { "roleId": "ullamco adipisicing aliqua dolor" }, { "roleId": "id commodo" } ], "inactive": true, "_meta": { "created": "1952-10-04T08:22:12.205Z", "updated": "1950-10-08T06:04:21.561Z", "migrationVersion": -76697898 } }, "default" ], "iterations": [ "431F327E-eC8b-5b1b-3781-A028a0F52c9d", "00BD78c7-A873-76dE-Ca9C-0ccdEfbEbE0D" ] }, "d": { "actor": "Pronghorn", "groups": [ { "_id": "4ddf07f4756edc3b16b1ade8", "provenance": "ipsum", "name": "labore exercitation", "description": "deserunt dolore tempor", "memberOf": [ { "groupId": "f7f0fbb169bd555f41e45b1b", "aaaManaged": true }, { "groupId": "b67ad3b2ff2cac028a4913d7", "aaaManaged": true }, { "groupId": "5831dd50141e71d1865b679f", "aaaManaged": false }, { "groupId": "f5cc4fa9807b6f4d719a77a5", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "consequat Excepteur" }, { "roleId": "est irure dolor laboris enim" }, { "roleId": "dolor enim est ipsum" } ], "inactive": false, "_meta": { "created": "1989-02-04T01:21:25.897Z", "updated": "1960-11-21T05:53:22.458Z", "migrationVersion": -13048392 } }, "341c4b40596621bd4949dd04", "6fb8f644026a36e6b6c17898", "default", "default" ], "iterations": [ "Cf3cD3c6-7719-1b5D-3BD4-a77a7ceE8E80", "b2dAaAa5-CEaD-09CF-c3B5-b6e96E6cFd19", "40Ebc691-ccF0-ee2b-47fd-3be79EAbd3ef", "Ae51e202-6aa8-BA0a-dc5D-7DD38eafba50" ], "x": 77706876.75410968, "y": -20138561.12768595, "gridCoordinate": { "x": -81243152.89499179, "y": -11098161.552820414 }, "name": "occaecat veniam", "location": "Broker", "locationType": null, "app": "eu", "canvasName": "in", "displayName": "Duis officia", "summary": "eu", "description": "Excepteur esse fugiat labore", "variables": { "error": "", "decorators": [ { "type": "encryption", "pointer": "/~0/~1" } ] }, "deprecated": true, "scheduled": true, "matched": [ { "key": "amet ex cillum in", "highlightString": "Ut ipsum ut aliqua" }, { "key": "Lorem consequat Duis", "highlightString": "dolore" } ], "status": "failure", "previous": { "incomplete": [ "error_handler", "error_handler", "workflow_end" ], "complete": [ "workflow_end" ], "error": [ "error_handler" ] }, "taskId": "workflow_start", "transitions": { "success": [ { "task": "workflow_start", "type": "revert" } ], "failure": [ { "task": "3a1f", "type": "standard" }, { "task": "3a1f", "type": "revert" } ], "error": [ { "task": "workflow_end", "type": "loop" } ] }, "serverId": "nulla", "start_time": "1991-08-29T19:43:48.296Z", "end_time": -69348377.20197202, "finish_state": "success", "retrySettings": null, "type": "manual", "view": "anim pariatur officia deserunt" } }, "parent": { "job": "dolor voluptate", "task": "nisi et proident tempor nulla", "iteration": 50067132.98099527, "element": 76185914.22780386 }, "errorHandler": null, "groups": [ "3b04541d936f91a84400288e", "9231fc2c3601888088598d06", { "_id": "c78f24bff47ab879d843c934", "provenance": "anim", "name": "incididunt in et officia", "description": "ut proident nisi nulla", "memberOf": [ { "groupId": "3c7884fdfc95584703cfb9e7", "aaaManaged": true }, { "groupId": "29b15fbe057dbe55e02321a8", "aaaManaged": true }, { "groupId": "16a679cc2b5b5e64839fcafb", "aaaManaged": false }, { "groupId": "4a064dac1a94c79c59b8046e", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "occaecat sed qui" }, { "roleId": "Lorem cupidatat consequat minim" } ], "inactive": true, "_meta": { "created": "2007-11-25T20:34:41.118Z", "updated": "1970-06-16T23:54:53.049Z", "migrationVersion": 86899553 } } ], "watchers": [ "Pronghorn", "df052d06d832f56498850815", "ee2009bf17c44271e7c8090a", "f3db9cd72be27ad53daa7d49" ], "metrics": { "start_time": -63999898.04949549, "progress": 0.8006683188941257, "end_time": -46561082.58833713, "user": { "_id": "99c85c1033af145a3ea52619", "provenance": "Lorem et", "username": "minim", "firstname": "esse", "memberOf": [ { "groupId": "39a3180ab8ab50f8b71644d2", "aaaManaged": false }, { "groupId": "be91290654a0c3dc1dea7729", "aaaManaged": true }, { "groupId": "ffcf3d61f973d6d473c05ffa", "aaaManaged": false }, { "groupId": "38ce4fc8a9f17726bb5902e7", "aaaManaged": false }, { "groupId": "681e7a80283742a71fc31d81", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "laboris ullamco aliqua Duis anim" }, { "roleId": "elit sint dolor ex labore" }, { "roleId": "irure sunt mollit dolor" } ], "inactive": true, "lastLogin": "1953-10-22T10:55:56.089Z", "_meta": { "created": "1963-10-11T19:06:04.656Z", "updated": "1988-07-18T10:38:50.205Z", "migrationVersion": -95286091 }, "email": "ipsum aute exercitation dolor" }, "owner": "Pronghorn" } } }
{ "title": "job", "allOf": [ { "$ref": "common-api#/definitions/success-response" }, { "type": "object", "properties": { "data": { "$ref": "job-api" } } } ] }