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,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 retrieved search results", "data": { "_id": "0d6b92505de344f3f6c6f77e", "font_size": 15661169, "type": "resource:action", "created": "2022-07-01T12:19:29.814Z", "last_updated": "2000-05-25T05:58:28.69Z", "createdVersion": "957.71978.5", "lastUpdatedVersion": "2582.7748.472337", "canvasVersion": 3, "encodingVersion": 1, "migrationVersion": 38692388, "name": "myCoolDocumentName", "description": "Some helpful information about the document", "preAutomationTime": -18233514.19236672, "sla": -95765267.11616729, "decorators": [ { "type": "encryption", "pointer": "/YVuY//d.4/~0" }, { "type": "encryption", "pointer": "/mNUKibnO+/vkD+OYAdT/~1/~0/~1/~0/~0/~1/muByCD/~0" }, { "type": "encryption", "pointer": "/ak" }, { "type": "encryption", "pointer": "/~1/s71f9E,52w2/za/jJ/~0" } ], "status": "error", "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": "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": "3a1f", "name": "myCoolDocumentName", "message": "laborum mollit sit culpa" }, { "task": "workflow_start", "name": "myCoolDocumentName", "message": "aliquip" }, { "task": "3a1f", "name": "myCoolDocumentName" }, { "task": "workflow_start", "name": "myCoolDocumentName", "message": "proident culpa" }, { "task": "error_handler", "name": "myCoolDocumentName", "message": "in sint cupidatat" } ], "ancestors": null, "validationErrors": [ { "keyword": "aute sed", "dataPath": "reprehenderit Ut", "schemaPath": "deserunt anim cillum laboris", "message": "non cillum" }, { "keyword": "ut exercitation irure", "dataPath": "sunt", "schemaPath": "id dolor", "message": "est" }, { "keyword": "id aliqua non", "dataPath": "in nulla aliquip quis exercitation", "schemaPath": "pariatur", "message": "veniam laborum esse" }, { "keyword": "sint magna", "dataPath": "consectetur nulla aute", "schemaPath": "sed labore ut deserunt", "message": "sed magna sunt dolore" }, { "keyword": "reprehenderit in", "dataPath": "ea", "schemaPath": "dolor eu enim", "message": "eu" } ], "created_by": null, "last_updated_by": "Pronghorn", "tasks": { "workflow_start": { "x": -25659348.236186475, "y": 16674393.48451145, "gridCoordinate": { "x": 13736951.675655946, "y": 49530506.04857615 }, "name": "workflow_start", "summary": "workflow_start", "taskId": "workflow_start", "metrics": { "start_time": -93707817.1673428, "finish_state": "failure", "user": null }, "groups": [ "6980ff429012996556de10b3", "default", "default", "a10ea5dfe5e60b52e4baa26e", { "_id": "c73f96343203e4bd4b94cc7d", "provenance": "officia ut culpa", "name": "voluptate Ut ut", "description": "Excepteur enim proident sunt ut", "memberOf": [ { "groupId": "5b51642e98097888fd4a5940", "aaaManaged": false }, { "groupId": "3877ad045aa7b8f52cd0080f", "aaaManaged": false }, { "groupId": "0b65f25e8acf413751065cb5", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "do" }, { "roleId": "ullamco Excepteur sed laboris eiusmod" }, { "roleId": "voluptate" }, { "roleId": "in eiusmod occaecat enim minim" }, { "roleId": "fugiat qui nostrud" } ], "inactive": true, "_meta": { "created": "2014-10-04T05:33:15.474Z", "updated": "1963-06-08T08:02:18.085Z", "migrationVersion": -89734605 } } ], "iterations": [ "4bDD7c46-4fBb-0249-6c3E-9Cd5DCEeEb34" ] }, "workflow_end": { "x": -56620747.03348989, "y": 64336434.39927894, "gridCoordinate": { "x": -41110249.21366911, "y": -47250825.44152861 }, "name": "workflow_end", "summary": "workflow_end", "taskId": "workflow_end", "endTasks": { "incomplete": [ "3a1f" ], "complete": [ "e28f" ], "error": [ "workflow_end" ] }, "metrics": { "end_time": -16894894.144445866, "run_time": -6891246.486451715 }, "groups": [ { "_id": "3414c24686b9515299382f44", "provenance": "qui ullamco", "name": "ad in anim", "description": "quis enim nulla", "memberOf": [ { "groupId": "4be3b23d57217338abc9dfc4", "aaaManaged": true }, { "groupId": "3dbe30e234bee898d631a1a2", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "veniam Ut tempor id" }, { "roleId": "cillum consequat culpa sunt Lorem" }, { "roleId": "magna dolor aliquip cillum" } ], "inactive": true, "_meta": { "created": "1975-04-29T13:23:42.739Z", "updated": "1948-12-07T15:56:39.393Z", "migrationVersion": -35598492 } }, "5e37e9fce7c55700eaa5ef7d" ], "iterations": [ "CB84fDD1-Abb6-77E2-fBde-bDCaBeeB7EcE" ] }, "error_handler": { "x": -20535373.626943484, "y": -26167135.707625195, "gridCoordinate": { "x": -33125864.770597383, "y": 50566324.32099676 }, "name": "childJob", "location": "Adapter", "locationType": "amet", "app": "et", "canvasName": "ipsum veniam", "displayName": "qui amet", "summary": "cupidatat do sint esse nostrud", "description": "Excepteur enim", "variables": { "error": "", "decorators": [ { "type": "encryption", "pointer": "/r0K//~0" } ] }, "deprecated": false, "scheduled": true, "matched": [ { "key": "id dolor exercitation incididunt", "highlightString": "esse dolor anim veniam" }, { "key": "occaecat dolor consequat amet non", "highlightString": "anim" } ], "status": "incomplete", "previous": { "incomplete": [ "error_handler" ], "complete": [ "workflow_start", "workflow_start", "error_handler", "workflow_start", "workflow_start" ], "error": [ "workflow_end", "workflow_start", "e28f", "error_handler", "workflow_start" ] }, "taskId": "error_handler", "transitions": { "success": [ { "task": "3a1f", "type": "revert" } ], "failure": [ { "task": "workflow_start", "type": "loop" }, { "task": "workflow_start", "type": "revert" }, { "task": "error_handler", "type": "loop" }, { "task": "workflow_end", "type": "loop" } ], "error": [ { "task": "3a1f", "type": "standard" }, { "task": "workflow_end", "type": "loop" }, { "task": "error_handler", "type": "loop" }, { "task": "e28f", "type": "standard" }, { "task": "workflow_start", "type": "revert" } ] }, "serverId": "et aliquip pariatur cupidatat", "start_time": "1988-02-27T23:23:20.838Z", "end_time": -47272198.98750432, "finish_state": "error", "retrySettings": { "state": [ "error" ], "autoRetry": false, "limit": 86807019, "delay": 46346505, "count": 17281896, "finishedRetrying": true }, "type": "operation", "actor": "Pronghorn", "groups": [ { "_id": "d9411bd74c04694a523e663d", "provenance": "fugiat irure deserunt", "name": "aliquip sit", "description": "aute labore aliqua magna proident", "memberOf": [ { "groupId": "e88b2f79869fe92d34bf0c20", "aaaManaged": false }, { "groupId": "29875e65c8a1f7dd6b4decfa", "aaaManaged": true }, { "groupId": "45f8d29cacd74c0730025b79", "aaaManaged": true }, { "groupId": "b17d7da3a583abbb52a2677c", "aaaManaged": false }, { "groupId": "b7ece82d23933d65abae5ab0", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "consequat" } ], "inactive": true, "_meta": { "created": "2000-12-09T21:34:41.992Z", "updated": "1972-12-02T17:51:20.581Z", "migrationVersion": 61425548 } }, { "_id": "17aaa3ed0c696b9a370a4668", "provenance": "nisi occaecat", "name": "reprehenderit dolor esse", "description": "labore ea Excepteur", "memberOf": [ { "groupId": "2a25e78b7da31280b683c45b", "aaaManaged": true }, { "groupId": "9b630ecb754a0ee689b5e9bb", "aaaManaged": false }, { "groupId": "5fdcfbb8c95751ca33d72237", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "labore" }, { "roleId": "ea" }, { "roleId": "est adipisicing" }, { "roleId": "eu laboris" } ], "inactive": false, "_meta": { "created": "2023-01-27T00:16:53.295Z", "updated": "1965-07-01T13:45:38.456Z", "migrationVersion": 53829624 } }, "default", "aabc2237bc7c59d9e5ce2c6b", { "_id": "d025019c13e9da50fd33bfe0", "provenance": "aute laborum irure reprehenderit", "name": "consequat pariatur mollit", "description": "est in sint dolor cillum", "memberOf": [ { "groupId": "2ffb2a1e86f65b89c530446b", "aaaManaged": false }, { "groupId": "bfa1f4636209172a655a487d", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "ullamco elit sint ea" }, { "roleId": "in mollit nisi eiusmod ut" }, { "roleId": "consequat" }, { "roleId": "exercitation in dolore" }, { "roleId": "occaecat consequat" } ], "inactive": true, "_meta": { "created": "1983-02-19T02:36:44.013Z", "updated": "2001-12-19T22:51:39.531Z", "migrationVersion": -84855561 } } ], "iterations": [ "6aB44B7A-EFA6-6038-a5a5-7FF4e14c3b45", "F42A1f4b-e4A8-0B6a-F6aB-dc09e91f420a", "A9CEd1e5-E3e8-7207-dD37-caea0d1dCf8c" ] }, "b": { "x": -99330450.21546279, "y": 19819937.397235915, "gridCoordinate": { "x": 58483369.109659225, "y": 33369614.139718845 }, "name": "ipsum proident sed nulla", "location": "Broker", "locationType": "id amet eu pariatur qui", "app": "labore ad consequat commodo", "canvasName": "cillum pariatur in consectetur", "displayName": "irure aliqua", "summary": "proident eiusmod nisi officia", "description": "do laborum Lorem", "variables": { "error": "", "decorators": [ { "type": "encryption", "pointer": "/Q2TXw2kFb/~1/U/PAfDjT/GLtH2c0/cV5G1" }, { "type": "encryption", "pointer": "/AL/iS0.V/u1RaS0af/~1/Hu+/+6dwVXQ/~0/rsnXPI/~0/~0/vgax.M+GIF,/E7i/~0" }, { "type": "encryption", "pointer": "/~1/E" } ] }, "deprecated": false, "scheduled": true, "matched": [ { "key": "dolor sed ullamco irure eiusmod", "highlightString": "mollit quis" }, { "key": "ex Excepteur in", "highlightString": "velit Lorem fugiat et cupidatat" } ], "status": "canceled", "previous": { "incomplete": [ "e28f", "e28f", "workflow_start", "workflow_end", "workflow_start" ], "complete": [ "error_handler", "workflow_end", "3a1f", "error_handler" ], "error": [ "workflow_end", "3a1f", "error_handler" ] }, "taskId": "3a1f", "transitions": { "success": [ { "task": "3a1f", "type": "loop" }, { "task": "workflow_start", "type": "standard" }, { "task": "error_handler", "type": "revert" }, { "task": "3a1f", "type": "revert" } ], "failure": [ { "task": "workflow_start", "type": "standard" }, { "task": "workflow_start", "type": "loop" }, { "task": "workflow_start", "type": "standard" }, { "task": "e28f", "type": "standard" }, { "task": "e28f", "type": "loop" } ], "error": [ { "task": "workflow_start", "type": "loop" }, { "task": "e28f", "type": "revert" } ] }, "serverId": "elit dolore ad voluptate ut", "start_time": "2012-04-08T10:20:39.287Z", "end_time": 84461350.20084578, "finish_state": "error", "retrySettings": { "state": [ "failure" ], "autoRetry": true, "limit": 24551385, "delay": 56608596, "count": 94633906, "finishedRetrying": false }, "type": "operation", "actor": "job", "groups": [ { "_id": "9e3f72c5ef3aaef9dbc547d3", "provenance": "enim", "name": "officia", "description": "fugiat ut ea", "memberOf": [ { "groupId": "ee9dd3af60faee8c0847b9f2", "aaaManaged": false }, { "groupId": "7be9720a7fc41632d43d22be", "aaaManaged": false }, { "groupId": "868a88ca71d0643a4637d23f", "aaaManaged": true }, { "groupId": "aa0545406421cdb1dddd0850", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "cupidatat velit" } ], "inactive": false, "_meta": { "created": "1973-12-15T12:16:36.76Z", "updated": "1984-10-24T05:28:08.154Z", "migrationVersion": -72696972 } }, "default" ], "iterations": [] } }, "parent": { "job": "irure amet", "task": "irure elit", "iteration": -93054959.6330879, "element": -90349959.67863804 }, "errorHandler": null, "groups": [ "default", { "_id": "f49e38d62aa374b26df9c24e", "provenance": "velit", "name": "ut Excepteur ea in", "description": "eiusmod laborum commodo in in", "memberOf": [ { "groupId": "88f9b6a653a7e1157ece90fe", "aaaManaged": false }, { "groupId": "0b60df1bfffef11465e7789d", "aaaManaged": true }, { "groupId": "acf650bc36dc5f241e9f223c", "aaaManaged": true }, { "groupId": "ab4ebf56a2b1e63e60e2e7c6", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "ipsum proident magna" }, { "roleId": "labore do ipsum ad" } ], "inactive": true, "_meta": { "created": "2004-09-23T00:36:19.758Z", "updated": "2019-03-16T16:40:03.882Z", "migrationVersion": 51542797 } }, "28c49701ec00cb90ec74b15a" ], "watchers": [ "Pronghorn", { "_id": "e484deed600e2a7a7d8dd206", "provenance": "in velit culpa", "username": "nisi", "firstname": "consequat irure non in qui", "memberOf": [ { "groupId": "08d4ec7df1e73e74525e2361", "aaaManaged": true }, { "groupId": "ab5295173ddb5b0e0debaac0", "aaaManaged": true }, { "groupId": "338c0d06dd3c119d92ff9e8b", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "laboris dolore sunt id" } ], "inactive": false, "lastLogin": "1947-05-03T01:42:43.052Z", "_meta": { "created": "2004-06-01T20:04:39.622Z", "updated": "1984-05-07T15:59:38.334Z", "migrationVersion": 32202611 }, "email": "in adipisicing esse amet" }, "Pronghorn" ], "metrics": { "start_time": 60361884.10731408, "progress": 0.9985584567815065, "end_time": -59023689.61183062, "user": "Pronghorn", "owner": { "_id": "edd2db4a870c5229ce8625b6", "provenance": "qui quis anim", "username": "enim consequat", "firstname": "labore", "memberOf": [ { "groupId": "d745a145b893bb4488261ef6", "aaaManaged": false }, { "groupId": "529abd50a2bbc5c00a7e803b", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "adipisicing amet eu esse sint" }, { "roleId": "mollit magna" }, { "roleId": "in proident in non" }, { "roleId": "Ut in sunt incididunt" } ], "inactive": false, "lastLogin": "1959-01-12T13:39:25.049Z", "_meta": { "created": "1991-10-12T18:13:22.268Z", "updated": "1994-06-12T22:09:14.931Z", "migrationVersion": -98540997 }, "email": "do" } } } }
{ "title": "job", "allOf": [ { "$ref": "common-api#/definitions/success-response" }, { "type": "object", "properties": { "data": { "$ref": "job-api" } } } ] }