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": "description", "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 imported 3 of 4 documents", "data": { "_id": "749f5b3844e425659ba992cd", "uuid": "9ed8cded-44ed-82fc-7b52-bed117cfbdcd", "font_size": -19477809, "type": "automation", "created": "2017-10-19T17:39:44.881Z", "last_updated": "2013-01-30T02:05:33.17Z", "createdVersion": "27548.68918.471955-7638.352.450.71926", "lastUpdatedVersion": "62910.7162924.2-7745.6.1212", "canvasVersion": 2, "encodingVersion": 1, "migrationVersion": -82834726, "name": "myCoolDocumentName", "description": null, "preAutomationTime": -67890178.4933723, "sla": 71366885.42332652, "decorators": [ { "type": "encryption", "pointer": "/pK7/GIH/XuwRPz51/IJrA/Fo1RDBII-/v/~1/KHoR+7-JzR/GUiGrq/jN,VYwan.M/Koump." }, { "type": "encryption", "pointer": "/~1/~0/~1/rouL/XWkrm5,71/~1/M-AEPgnTm0/JgmzmrcKhV/~1/~0/~0" }, { "type": "encryption", "pointer": "/HAr/l87+rcfBKK/y0/~1/~0/~0/CmbvG//l9/xWeQc0Jq0Q/Nf" }, { "type": "encryption", "pointer": "/~0/loxVjt/dyMD07/x2vGLdfY/~1/~1/~0/jjd" } ], "status": "complete", "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": "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": "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": "e28f", "name": "myCoolDocumentName", "message": "sed consequat Ut" }, { "task": "e28f", "name": "myCoolDocumentName" }, { "task": "3a1f", "name": "myCoolDocumentName", "message": "ad nisi dolor Lorem eu" } ], "ancestors": [ "0ae1144a0869ee8ab79728be", "7f3e4a8fbfc5c4a9f80a4841" ], "validationErrors": [ { "keyword": "dolore", "instancePath": "Ut culpa in est", "schemaPath": "adipisicing quis sint", "message": "elit ex" } ], "created_by": "6800d4aa69fb5e7671374bb8", "last_updated_by": "34c9b13fc89bf878161fbe4e", "tasks": { "workflow_start": { "x": -83993675.2218724, "y": -99365251.89695655, "gridCoordinate": { "x": 95041822.92436445, "y": 42984203.57157022 }, "name": "workflow_start", "summary": "workflow_start", "taskId": "workflow_start", "metrics": { "start_time": -83356670.37906788, "finish_state": "success", "user": null }, "groups": [ { "_id": "e6fe5ad0c52ba4d27b1d0cfb", "provenance": "quis esse", "name": "aliquip Excepteur", "description": "consequat voluptate sit", "memberOf": [ { "groupId": "10c55ea39eb10729fcf75f16", "aaaManaged": false }, { "groupId": "8eaac69d0f23fd4b1651b01c", "aaaManaged": true }, { "groupId": "1b57559d653de4c1380a31ed", "aaaManaged": true }, { "groupId": "480cc89eee45ef53df7f3349", "aaaManaged": false }, { "groupId": "f13f39972e997ba1f5a2b3ac", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "commodo" }, { "roleId": "mollit cillum in dolor" }, { "roleId": "occaecat Ut est consectetur" }, { "roleId": "exercitation qui" }, { "roleId": "aliqua enim dolor aute laborum" } ], "inactive": true, "_meta": { "created": "1994-05-09T00:04:43.739Z", "updated": "1978-06-03T22:28:17.679Z", "migrationVersion": 31112775 } }, "3775531b7ec5086276cb2296", "dd38ac677fd20fcbf324a6a9", { "_id": "114996a685e48924b93c102b", "provenance": "ea mollit Excepteur sunt", "name": "anim minim eiusmod deserunt", "description": "deserunt consequat", "memberOf": [ { "groupId": "44896ed9b93e186a22ed6537", "aaaManaged": false }, { "groupId": "59639595dffb4f6ba2e0d6da", "aaaManaged": false }, { "groupId": "2253c06e7e3ed6186babc0ea", "aaaManaged": true }, { "groupId": "57bbbe7f96a6d3872bef5847", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "Lorem fugiat esse" }, { "roleId": "ullamco reprehenderit et minim nisi" }, { "roleId": "sint ullamco dolor" }, { "roleId": "pariatur anim sed ipsum sit" } ], "inactive": false, "_meta": { "created": "2004-08-31T05:35:53.617Z", "updated": "1974-09-20T19:44:43.654Z", "migrationVersion": -5621800 } } ], "iterations": [ "5A84B9EE-D7FF-3b0a-8Bc4-8BDd4abEFCd6" ] }, "workflow_end": { "x": -12969884.123727664, "y": 17185315.333875105, "gridCoordinate": { "x": -19903070.90637988, "y": 3766692.9780917764 }, "name": "workflow_end", "summary": "workflow_end", "taskId": "workflow_end", "endTasks": { "incomplete": [ "e28f", "workflow_end", "workflow_start", "workflow_start", "workflow_start" ], "complete": [ "workflow_start", "workflow_end", "workflow_start" ], "error": [ "workflow_start", "error_handler", "workflow_start", "e28f" ] }, "metrics": { "end_time": -86056989.68626907, "run_time": -50098681.66337763 }, "groups": [ "28115a429a87b24ec40bf940", { "_id": "342d85dd2dec4c71c330bc7a", "provenance": "occaecat consequat sit ullamco nulla", "name": "in Ut officia voluptate sit", "description": "incididunt", "memberOf": [ { "groupId": "d7d7bce79e458d1a42ec59de", "aaaManaged": true }, { "groupId": "0bcb50c232bf15db86385960", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "do velit veniam dolore deserunt" }, { "roleId": "ex" }, { "roleId": "adipisicing anim" }, { "roleId": "ullamco mollit" } ], "inactive": false, "_meta": { "created": "1958-04-24T23:08:25.841Z", "updated": "2003-07-05T09:39:56.464Z", "migrationVersion": 14965822 } }, { "_id": "f5e5fc69db9b68f3211bc38b", "provenance": "enim", "name": "sed proident amet mollit", "description": "cupidatat", "memberOf": [ { "groupId": "a91c469a8546d960c1db1f27", "aaaManaged": false }, { "groupId": "8cb1f8f9ff1960ab99266e5f", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "pariatur aliquip" }, { "roleId": "dolore laboris" }, { "roleId": "Duis dolor quis dolor cupidatat" }, { "roleId": "dolor velit id reprehenderit" } ], "inactive": true, "_meta": { "created": "1947-12-29T17:32:11.756Z", "updated": "1979-06-01T00:26:34.881Z", "migrationVersion": -56303588 } }, { "_id": "05cc7f418e0dcbb9b65ee3c8", "provenance": "sunt aliquip do", "name": "id sint laboris", "description": "Duis fugiat est", "memberOf": [ { "groupId": "901eaa4ae328646b8e81f301", "aaaManaged": true }, { "groupId": "cc756a8f53b4dfc9387bbf36", "aaaManaged": false }, { "groupId": "d38bc0a1fb7cc669a5a21ef7", "aaaManaged": true }, { "groupId": "da3147de52c45de00a21e27f", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "officia qui" }, { "roleId": "cillum esse amet nostrud" }, { "roleId": "mollit non cillum Ut" }, { "roleId": "non aute dolor" }, { "roleId": "proident" } ], "inactive": true, "_meta": { "created": "1954-08-13T01:11:50.927Z", "updated": "1964-09-21T06:57:08.535Z", "migrationVersion": 82800241 } }, "462b430f9c71e7ec20b52bb1" ], "iterations": [ "1C93DaDA-C2a9-0A5D-9BEc-CbDe1adCBB6f", "cEd868aa-2800-E7D2-CEDa-2E5B3aE3BED6" ] }, "error_handler": { "x": -87686106.21061823, "y": -5517741.366347104, "gridCoordinate": { "x": -73760411.05524305, "y": 40642685.96657294 }, "name": "childJob", "location": "Application", "locationType": "velit deserunt et sit sed", "app": "fugiat et ipsum cillum", "canvasName": "eu", "displayName": "amet est", "summary": "voluptate Duis nulla ullamco", "description": "fugiat ea aliqua voluptate", "variables": { "error": "", "decorators": [ { "type": "encryption", "pointer": "/f64bzzXvVfL/~1/~0/fm/~1/TI/~1/~0/~1/T51z7nK5Jo" }, { "type": "encryption", "pointer": "/~1/rOrsk,nN" } ] }, "deprecated": false, "scheduled": false, "matched": [ { "key": "ad officia velit enim", "highlightString": "reprehenderit" }, { "key": "ad nostrud", "highlightString": "ex eiusmod ut elit" }, { "key": "dolore ut Lorem veniam", "highlightString": "nulla deserunt cillum enim eiusmod" }, { "key": "dolore", "highlightString": "anim sunt ea dolor" } ], "status": "error", "previous": { "incomplete": [ "workflow_end", "3a1f" ], "complete": [ "workflow_start" ], "error": [ "workflow_end", "workflow_start", "workflow_start" ] }, "taskId": "workflow_end", "transitions": { "success": [ { "task": "workflow_start", "type": "standard" }, { "task": "workflow_start", "type": "standard" }, { "task": "workflow_start", "type": "standard" }, { "task": "e28f", "type": "loop" }, { "task": "workflow_start", "type": "standard" } ], "failure": [ { "task": "workflow_start", "type": "loop" }, { "task": "workflow_start", "type": "standard" }, { "task": "3a1f", "type": "revert" } ], "error": [ { "task": "3a1f", "type": "loop" }, { "task": "workflow_start", "type": "standard" }, { "task": "workflow_start", "type": "standard" }, { "task": "workflow_start", "type": "revert" } ] }, "serverId": "dolor aute amet ut", "start_time": "2010-11-07T08:46:41.205Z", "end_time": -42250069.56315842, "finish_state": "failure", "retrySettings": null, "type": "operation", "actor": "Pronghorn", "groups": [ "9f5c330e6a0a03b67a1a34c5", { "_id": "6127992567a7faba33fc0374", "provenance": "do", "name": "nostrud in dolore", "description": "elit exercitation dolor", "memberOf": [ { "groupId": "a01dd8cd47539d3632af181f", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "laborum velit" }, { "roleId": "in exercitation dolor" }, { "roleId": "exercitation ipsum" }, { "roleId": "esse tempor dolore" } ], "inactive": false, "_meta": { "created": "1999-07-28T23:13:15.888Z", "updated": "1981-03-11T20:16:18.882Z", "migrationVersion": -89780144 } }, "66be2ec959d177bc85314c3c" ], "iterations": [ "b371658F-0f9f-D7Eb-E5d3-aE5Ea3bf66f9", "bA45B954-7F63-B5c4-14b7-aeC3FD29FdfF", "CFA4D6Dc-Ac6D-ddb5-20b5-F68A4bbe8Cdb", "1c8beDba-fb1C-D70B-Cc2C-cd45b246DeE2" ] }, "afd6": { "actor": "job", "groups": [ "default", "b799dc0025166a7006568814", "default", "6f55c0c961821f7cb55206a7", "default" ], "iterations": [ "b2CEBB03-5Aad-B755-Fd87-86871950eaDC", "C205301c-3CfC-BC34-c0B0-b2DdCaC8Aac5" ], "x": -3506286.4595710486, "y": -42723382.687981546, "gridCoordinate": { "x": 47179444.726501435, "y": -87214631.82030936 }, "name": "nulla", "location": "Broker", "locationType": "ut irure", "app": "et est labore", "canvasName": "childJob", "displayName": "amet ut", "summary": "exercitation do culpa", "description": "Lorem et exercitation officia", "variables": { "error": "", "decorators": [ { "type": "encryption", "pointer": "/~1/fk5Ij/uWGU/yN./s5cpc+ISVz/UvcPz/HkFp/mO/~0/v5n6N7" }, { "type": "encryption", "pointer": "/gfjCZ88ZjUU/~0/M/Wb3/ofobL7ccMn" }, { "type": "encryption", "pointer": "/~0/~1/UbFbpfZ/jBUXL/HGb,ZwGDo" }, { "type": "encryption", "pointer": "/~0/~1" }, { "type": "encryption", "pointer": "/EVQzEy/~0/~1/~0/~0/POt0" } ] }, "deprecated": false, "scheduled": false, "matched": [ { "key": "in", "highlightString": "ut veniam laborum" }, { "key": "voluptate non id sed ad", "highlightString": "et incididunt officia" }, { "key": "enim velit nulla non reprehenderit", "highlightString": "et id eu" }, { "key": "amet Lorem sint sit ut", "highlightString": "in Lorem voluptate" }, { "key": "anim dolor", "highlightString": "Duis in sit laborum" } ], "status": "paused", "previous": { "incomplete": [ "e28f", "workflow_start" ], "complete": [ "workflow_end", "workflow_start", "workflow_end" ], "error": [ "3a1f", "3a1f", "3a1f" ] }, "taskId": "workflow_end", "transitions": { "success": [ { "task": "workflow_start", "type": "revert" }, { "task": "workflow_start", "type": "revert" }, { "task": "workflow_end", "type": "revert" }, { "task": "workflow_start", "type": "loop" }, { "task": "3a1f", "type": "revert" } ], "failure": [ { "task": "e28f", "type": "revert" }, { "task": "workflow_end", "type": "loop" }, { "task": "e28f", "type": "revert" } ], "error": [ { "task": "workflow_start", "type": "loop" } ] }, "serverId": "enim Lorem culpa eiusmod", "start_time": "1964-09-30T00:19:22.184Z", "end_time": 53864999.44015476, "finish_state": "error", "retrySettings": { "state": [ "success", "error", "success", "success" ], "autoRetry": true, "limit": 25360461, "delay": 36435771, "count": 98296725, "finishedRetrying": true }, "loop": { "atLeastOneComplete": true, "finishedCount": -80916708.88149256, "outgoing": [] }, "childJobs": [ { "_id": "et quis dolor veniam sed", "name": "commodo est proident culpa", "iteration": 31493020.215707272 } ] } }, "parent": { "job": "Duis sed ex dolor aliquip", "task": "aute aliquip labore", "iteration": 20049768.506505698, "element": 76318560.04041052 }, "errorHandler": null, "groups": [ "2b6cec4875ebdf89b4543dea" ], "watchers": [ "Pronghorn", null, { "_id": "b6bcf54ea1c454cd6d8579af", "provenance": "esse", "username": "id", "firstname": "nostrud", "memberOf": [ { "groupId": "7c7bdf82f0f1f03bf523b04c", "aaaManaged": true }, { "groupId": "c0e0878888a93b486bf8d031", "aaaManaged": true }, { "groupId": "09f51f39158db353285a28d5", "aaaManaged": false }, { "groupId": "b6b4356ac2e9c1f6139c79f8", "aaaManaged": true }, { "groupId": "fe1b37aced12fd9acd8d1792", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "dolor ut culpa nisi" }, { "roleId": "commodo minim" }, { "roleId": "irure dolor est dolor" } ], "inactive": false, "lastLogin": "1949-06-09T07:50:37.196Z", "_meta": { "created": "1970-05-03T07:44:13.122Z", "updated": "1998-02-20T12:28:16.023Z", "migrationVersion": 60659031 }, "email": "cillum Excepteur anim pariatur enim" }, "Pronghorn" ], "metrics": { "start_time": -25086038.47228171, "progress": 0.029757806397024078, "end_time": 52938404.28314057, "user": "Pronghorn", "owner": "Pronghorn" } } }
{ "title": "job", "allOf": [ { "$ref": "common-api#/definitions/success-response" }, { "type": "object", "properties": { "data": { "$ref": "job-api" } } } ] }