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": "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 created the requested item", "data": { "_id": "e786ae24492e8eae72619847", "uuid": "2c746226-0b06-fbb6-b7c1-47981977df27", "font_size": -50551287, "type": "resource:compliance", "created": "2021-06-06T06:11:41.95Z", "last_updated": "2023-09-04T00:35:26.709Z", "createdVersion": "42189800962.5759942.63427986", "lastUpdatedVersion": "8624432709.149753.4815471-4625.022022.9861.578228059", "canvasVersion": 2, "encodingVersion": 1, "migrationVersion": -61742184, "name": "myCoolDocumentName", "description": null, "preAutomationTime": -68888503.05903502, "sla": 32883670.54596892, "decorators": [ { "type": "encryption", "pointer": "/~0/~1/~0/jTrOOs/~0" } ], "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 }, { "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": "laboris amet" }, { "task": "workflow_start", "name": "myCoolDocumentName", "message": "labore et nostrud ut fugiat" }, { "task": "e28f", "name": "myCoolDocumentName", "message": "do fugiat quis" }, { "task": "error_handler", "name": "myCoolDocumentName", "message": "ea" }, { "task": "3a1f", "name": "myCoolDocumentName" } ], "ancestors": null, "validationErrors": [ { "keyword": "aliquip veniam sit dolor sint", "instancePath": "dolor", "schemaPath": "aute nostrud Excepteur", "message": "mollit occaecat velit enim" }, { "keyword": "amet est mollit in quis", "instancePath": "tempor", "schemaPath": "velit sed ex Duis", "message": "ad id veniam sint" }, { "keyword": "Excepteur ad proident adipisicing", "instancePath": "et quis ad ex nisi", "schemaPath": "exercitation sit tempor", "message": "adipisicing magna qui officia" }, { "keyword": "officia culpa", "instancePath": "dolore in", "schemaPath": "nisi", "message": "cillum exercitation" } ], "created_by": { "_id": "585c6d40420f5288472edad2", "provenance": "consectetur", "username": "occaecat", "firstname": "in proident occaecat", "memberOf": [ { "groupId": "5643c921d0f2370dd15a1fdd", "aaaManaged": true }, { "groupId": "fca8cf54a96acf0b7ccffa10", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "nulla aute" }, { "roleId": "quis sit ex" }, { "roleId": "ex pariatur" } ], "inactive": true, "lastLogin": "1977-10-26T08:54:50.84Z", "_meta": { "created": "1956-08-20T15:03:56.416Z", "updated": "2024-07-04T19:05:55.861Z", "migrationVersion": 41852651 }, "email": "occaecat" }, "last_updated_by": null, "tasks": { "workflow_start": { "x": 47863320.1023055, "y": 3711217.1411522776, "gridCoordinate": { "x": 21504445.535637945, "y": 33730075.44220053 }, "name": "workflow_start", "summary": "workflow_start", "taskId": "workflow_start", "metrics": { "start_time": 72259001.84356916, "finish_state": "failure", "user": "Pronghorn" }, "groups": [ { "_id": "3462a13342694bca07ded6b5", "provenance": "reprehenderit voluptate", "name": "in consequat officia est do", "description": "ex est do eu exercitation", "memberOf": [ { "groupId": "576e1c35ea1c6b9f679eaa97", "aaaManaged": true }, { "groupId": "956b6a2dc67da76f993056b9", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "occaecat" }, { "roleId": "dolore fugiat labore" } ], "inactive": false, "_meta": { "created": "2013-05-15T12:08:08.423Z", "updated": "1997-01-15T22:21:51.075Z", "migrationVersion": 29272386 } }, { "_id": "aafcb3db1f2556484a6cb2ca", "provenance": "irure in magna ea", "name": "dolor sunt officia aliqua quis", "description": "Ut mollit aliquip anim", "memberOf": [ { "groupId": "ed57a0907c245f51201e127a", "aaaManaged": false }, { "groupId": "f8e9ef656421d3c6972c96f4", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "quis eiusmod laboris in" }, { "roleId": "cillum non consectetur" } ], "inactive": true, "_meta": { "created": "2004-11-01T01:21:57.341Z", "updated": "1973-01-22T16:36:55.028Z", "migrationVersion": -49782594 } }, { "_id": "79c2f015435fb3211b7dfdb4", "provenance": "sed aliqua in aliquip", "name": "Excepteur cupidatat", "description": "dolor labore id irure", "memberOf": [ { "groupId": "3e7b7d80ee8b3d2ee707aacf", "aaaManaged": true }, { "groupId": "99909d871084706b763afeaf", "aaaManaged": true }, { "groupId": "11e97da3914622d7973ea9f1", "aaaManaged": true }, { "groupId": "d969e8667f3a4ed70c40ee2a", "aaaManaged": true }, { "groupId": "0063e34164655f254d3d0d2b", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "Excepteur nostrud dolore incididunt" }, { "roleId": "cupidatat consectetur elit" }, { "roleId": "in" }, { "roleId": "esse" }, { "roleId": "commodo in cupidatat ea" } ], "inactive": true, "_meta": { "created": "1977-10-22T23:51:15.48Z", "updated": "2002-08-19T12:35:53.306Z", "migrationVersion": 35226405 } }, "89315971b4a0dd4bafea49c9", "c46854a35eb012d3a740c10d" ], "iterations": [ "59114eE6-A099-6e32-fcfE-7EE99FcBCCEe", "e69e2cbb-854E-2e0C-7319-59a60FF6DE7c", "cD97224D-d291-97b9-c2B7-F5EbF228b11e", "2e5ED2C4-a4Cf-716B-FDC5-dCD8Af4edFab" ] }, "workflow_end": { "x": 93641767.83312571, "y": 52870702.10173684, "gridCoordinate": { "x": 15733678.99823977, "y": -57707170.05141215 }, "name": "workflow_end", "summary": "workflow_end", "taskId": "workflow_end", "endTasks": { "incomplete": [ "error_handler", "3a1f", "3a1f", "workflow_end", "workflow_start" ], "complete": [ "e28f" ], "error": [ "3a1f", "e28f", "error_handler", "workflow_start", "3a1f" ] }, "metrics": { "end_time": 87398417.8361522, "run_time": -15551517.699200585 }, "groups": [ "default", "default", "badfd1436367834a4b6caedd", "default", "cd750935eba466cb8a8871ff" ], "iterations": [] }, "error_handler": { "x": 80648429.80422834, "y": -3322148.650381252, "gridCoordinate": { "x": -26266509.149228454, "y": -2365565.8823907226 }, "name": "childJob", "location": "Application", "locationType": null, "app": "exercitation reprehenderit laboris esse aute", "canvasName": "dolore consequat sint nulla anim", "displayName": "deserunt culpa est adipisicing irure", "summary": "proident ullamco cillum", "description": "qui aliquip", "variables": { "error": "", "decorators": [ { "type": "encryption", "pointer": "/OwM" }, { "type": "encryption", "pointer": "/~0/~1/~1/vD5M" }, { "type": "encryption", "pointer": "/~0/~1/ehXAj7HZ.P/~1/~0/re1e/~1/vZO2tG,v//iRQ4D/W.,-5FYC+" }, { "type": "encryption", "pointer": "/~1/~0/~0/~0" } ] }, "deprecated": false, "scheduled": true, "matched": [ { "key": "ad", "highlightString": "consequat in" }, { "key": "nostrud pariatur", "highlightString": "deserunt" }, { "key": "amet magna velit in", "highlightString": "quis" }, { "key": "qui incididunt aute quis reprehenderit", "highlightString": "dolore" }, { "key": "officia laborum aliqua dolor do", "highlightString": "ut" } ], "status": "incomplete", "previous": { "incomplete": [ "3a1f", "workflow_end" ], "complete": [ "error_handler", "workflow_start", "workflow_start", "3a1f", "workflow_start" ], "error": [ "3a1f", "3a1f", "3a1f", "workflow_start", "workflow_end" ] }, "taskId": "error_handler", "transitions": { "success": [ { "task": "e28f", "type": "standard" }, { "task": "e28f", "type": "loop" } ], "failure": [ { "task": "workflow_start", "type": "standard" }, { "task": "error_handler", "type": "standard" }, { "task": "workflow_end", "type": "revert" } ], "error": [ { "task": "workflow_end", "type": "loop" }, { "task": "workflow_end", "type": "standard" }, { "task": "3a1f", "type": "revert" } ] }, "serverId": "id laboris laborum Lorem", "start_time": "2018-11-23T14:45:32.335Z", "end_time": -13209463.88332875, "finish_state": "failure", "retrySettings": null, "type": "operation", "actor": { "_id": "caf1786fe8e9eb0969a01a7c", "provenance": "ut quis", "username": "ea ut laborum", "firstname": "amet magna", "memberOf": [ { "groupId": "873834add55d690ebb22fc1c", "aaaManaged": false }, { "groupId": "a9ff01fd57f80443d8cb1c86", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "aliqua" } ], "inactive": false, "lastLogin": "2018-11-26T23:39:11.39Z", "_meta": { "created": "1963-09-15T08:43:39.923Z", "updated": "1964-08-10T19:56:57.017Z", "migrationVersion": 86000536 }, "email": "ullamco pariatur" }, "groups": [ "f3b913b8237337d3096b8a24" ], "iterations": [] }, "c": { "actor": null, "groups": [ { "_id": "a1e86f35c3812daba7c5ac7e", "provenance": "ut eu do ipsum ut", "name": "exercitation", "description": "voluptate", "memberOf": [ { "groupId": "6686b28e86804ad32320479f", "aaaManaged": true }, { "groupId": "b2bcb2211e8d7114d3a7eeac", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "irure dolor eu dolore" }, { "roleId": "qui id" }, { "roleId": "sit" }, { "roleId": "ipsum culpa sunt veniam" }, { "roleId": "aliqua" } ], "inactive": true, "_meta": { "created": "1994-02-18T18:40:31.481Z", "updated": "2014-04-24T17:48:05.816Z", "migrationVersion": -60393323 } }, "default", "4d3340f68f7753f65bba65bf", "04133636ef67505d22388ef6", "default" ], "iterations": [ "6deBc555-Ed4A-06c5-289D-DdB03DcFEd4B" ], "x": 40142163.47746652, "y": -78628766.11475538, "gridCoordinate": { "x": 56211199.22563812, "y": 53616970.14836717 }, "name": "eu Duis velit Excepteur aliqua", "location": "Broker", "locationType": "quis consequat ad ut", "app": "mollit enim", "canvasName": "sed irure", "displayName": "Lorem", "summary": "consequat", "description": "elit tempor amet", "variables": { "error": "", "decorators": [ { "type": "encryption", "pointer": "/ySAfg/r/vEnmt" }, { "type": "encryption", "pointer": "/ozfQfUb-/TdQosECPp,q/~0/~0/~0/t4J3wOA8SLJ/~1/~0" }, { "type": "encryption", "pointer": "/~1/x1RNx.12I/UC,I44T/~1/ucBK" }, { "type": "encryption", "pointer": "/EP/~1/xc/b//~1/lqD6m3B-BFK" }, { "type": "encryption", "pointer": "/~0/~0/~0/WlKc/~1/SD2-cOF3/QhMwS/~1/~0/~0/A1" } ] }, "deprecated": false, "scheduled": false, "matched": [ { "key": "enim est dolor labore sit", "highlightString": "eiusmod" }, { "key": "proident velit exercitation voluptate", "highlightString": "nisi velit" } ], "status": "paused", "previous": { "incomplete": [ "error_handler" ], "complete": [ "e28f", "3a1f", "workflow_start" ], "error": [ "error_handler", "workflow_end", "error_handler", "workflow_start" ] }, "taskId": "error_handler", "transitions": { "success": [ { "task": "3a1f", "type": "revert" } ], "failure": [ { "task": "workflow_start", "type": "standard" }, { "task": "workflow_start", "type": "revert" }, { "task": "error_handler", "type": "standard" } ], "error": [ { "task": "workflow_start", "type": "standard" }, { "task": "workflow_start", "type": "revert" }, { "task": "workflow_start", "type": "standard" } ] }, "serverId": "dolore", "start_time": "2008-02-12T02:09:47.731Z", "end_time": 99020597.43936622, "finish_state": "failure", "retrySettings": null, "type": "manual", "view": "in et non deserunt" } }, "parent": { "job": "et eiusmod in amet magna", "task": "ullamco Ut cillum", "iteration": -5759321.477037817, "element": -8874598.192727402 }, "errorHandler": null, "groups": [ "66840ceceb18f81c5cb8635c", "default" ], "watchers": [ "Pronghorn", null, "cc5366233354910e50d5ecf2", { "_id": "7deb49cdc4501e6e66c4f034", "provenance": "incididunt velit", "username": "consequat qui aliqua in irure", "firstname": "voluptate mollit eiusmod", "memberOf": [ { "groupId": "c2ce3b0333fe046b8adc7128", "aaaManaged": false }, { "groupId": "69a4ac9e672ffdbee1908578", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "esse ullamco" }, { "roleId": "occaecat labore do in" }, { "roleId": "fugiat qui voluptate id" }, { "roleId": "et consequat occaecat" }, { "roleId": "Excepteur commodo officia consectetur" } ], "inactive": false, "lastLogin": "1987-10-07T15:47:27.732Z", "_meta": { "created": "1959-03-24T20:50:31.791Z", "updated": "1999-08-27T15:33:26.681Z", "migrationVersion": 67808851 }, "email": "magna sed pariatur" }, null ], "metrics": { "start_time": -7624409.1795151085, "progress": 0.9141655548780583, "end_time": -25945812.189730465, "user": "de55ccfd4648f763fd4b5261", "owner": null } } }
{ "title": "job", "allOf": [ { "$ref": "common-api#/definitions/success-response" }, { "type": "object", "properties": { "data": { "$ref": "job-api" } } } ] }