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", "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 imported 3 of 4 documents", "data": { "_id": "a432671ebe5c772dd1b42fa8", "uuid": "7b7a0f0e-ba49-eff3-8e8b-6017ca35239e", "font_size": 98341836, "type": "resource:action", "created": "1990-04-20T01:25:17.113Z", "last_updated": "1984-11-08T02:51:18.947Z", "createdVersion": "38469967944.94.05438875022-9784.38648005.98205578", "lastUpdatedVersion": "880.5518823638.3287169514-7373.143610861.5774689947", "canvasVersion": 3, "encodingVersion": 1, "migrationVersion": 83822629, "name": "myCoolDocumentName", "description": "Some helpful information about the document", "preAutomationTime": 55773806.64049289, "sla": 3912991.2826349586, "decorators": [ { "type": "encryption", "pointer": "/dT50RtW9C/fUQfVo/p.niiTiGQ0T/~0/~0/~1/YdWO8oC/x-nlx5SXPf" }, { "type": "encryption", "pointer": "/N2Fq.06P4IK/~1" }, { "type": "encryption", "pointer": "/~1/P/~1/cX8rv" }, { "type": "encryption", "pointer": "/nM7h0fPJ7/E2qkPlzmA6/v8zaJ/SXtNz-+Ht3Z/~1/~1/~1/~1/qD/~1/JgdFF" } ], "status": "running", "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": "proident sint ea pariatur" } ], "ancestors": null, "validationErrors": [ { "keyword": "sit", "instancePath": "aliqua sed adipisicing", "schemaPath": "quis exercitation", "message": "do Excepteur ut in est" } ], "created_by": null, "last_updated_by": null, "tasks": { "workflow_start": { "x": 62869628.20466927, "y": 21340945.296886593, "gridCoordinate": { "x": 71279964.42562005, "y": -83833409.19542901 }, "name": "workflow_start", "summary": "workflow_start", "taskId": "workflow_start", "metrics": { "start_time": -19909367.63112496, "finish_state": "failure", "user": "e6c5b0e63e96b8f277612b04" }, "groups": [ "d5c31bb046fef675c55c906e", { "_id": "e8541f3569404aa916de0eca", "provenance": "ad non ex", "name": "ex elit sunt commodo dolore", "description": "sit eiusmod occaecat non commodo", "memberOf": [ { "groupId": "70f167a4e7569d98873849e5", "aaaManaged": true }, { "groupId": "50f38eccc1bea4641c652305", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "sint et voluptate ut" }, { "roleId": "officia velit" } ], "inactive": false, "_meta": { "created": "1981-07-27T20:55:45.91Z", "updated": "1980-06-24T19:21:22.58Z", "migrationVersion": 872364 } }, "28a91e82f8925aa070c4175a", "b10e16f3f70e6f8e8a837a7c", "default" ], "iterations": [] }, "workflow_end": { "x": 3299457.313940212, "y": -16455587.67693545, "gridCoordinate": { "x": -25368778.925059006, "y": -65038367.30452921 }, "name": "workflow_end", "summary": "workflow_end", "taskId": "workflow_end", "endTasks": { "incomplete": [ "workflow_end", "3a1f", "workflow_start", "workflow_start" ], "complete": [ "error_handler", "e28f", "error_handler", "3a1f" ], "error": [ "workflow_end", "e28f", "e28f", "e28f", "workflow_end" ] }, "metrics": { "end_time": -6531253.748925269, "run_time": -19753714.575574353 }, "groups": [ { "_id": "726b570cb89eebc3162693b2", "provenance": "reprehenderit", "name": "occaecat dolor", "description": "dolore aliquip proident pariatur aute", "memberOf": [ { "groupId": "ac3f97dc514a37facb5de964", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "fugiat adipisicing" }, { "roleId": "dolor eu consectetur" } ], "inactive": true, "_meta": { "created": "1967-01-15T23:15:57.697Z", "updated": "2009-05-10T01:06:19.331Z", "migrationVersion": -11670519 } }, "ae996e40485b8ced845116f9", { "_id": "5d377920694e10194f0fbd43", "provenance": "nostrud aliqua", "name": "ad mollit sunt", "description": "nostrud consequat aute magna commodo", "memberOf": [ { "groupId": "87300af64cc699552c8ee8e4", "aaaManaged": false }, { "groupId": "53465d97d92d3f14e644afdf", "aaaManaged": false }, { "groupId": "1164b7bfdd4f44e9f2000081", "aaaManaged": false }, { "groupId": "1b104625bb772d8e16e2db3b", "aaaManaged": true }, { "groupId": "f945e19331893217eea097d2", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "sed" }, { "roleId": "est culpa anim" } ], "inactive": true, "_meta": { "created": "1995-09-07T20:54:29.734Z", "updated": "2016-04-09T12:45:39.507Z", "migrationVersion": -62913458 } }, "default" ], "iterations": [] }, "error_handler": { "x": 57045433.755296856, "y": 19190714.990552053, "gridCoordinate": { "x": 53237333.596209824, "y": -59878469.52891629 }, "name": "childJob", "location": "Adapter", "locationType": null, "app": "sit nisi ad eu dolor", "canvasName": "Lorem exercitation", "displayName": "labore do", "summary": "incididunt amet consectetur", "description": "dolore magna nisi eiusmod consectetur", "variables": { "error": "", "decorators": [ { "type": "encryption", "pointer": "/a7YC-vYY/a+NW1RRFzD7/e" } ] }, "deprecated": false, "scheduled": false, "matched": [ { "key": "in in dolor ex nulla", "highlightString": "ex elit in" }, { "key": "ea", "highlightString": "id ipsum" } ], "status": "canceled", "previous": { "incomplete": [ "workflow_start", "error_handler", "e28f", "workflow_start", "workflow_end" ], "complete": [ "error_handler" ], "error": [ "workflow_start", "workflow_start" ] }, "taskId": "3a1f", "transitions": { "success": [ { "task": "3a1f", "type": "loop" }, { "task": "workflow_start", "type": "loop" }, { "task": "error_handler", "type": "loop" } ], "failure": [ { "task": "3a1f", "type": "standard" }, { "task": "e28f", "type": "standard" }, { "task": "e28f", "type": "loop" }, { "task": "error_handler", "type": "revert" }, { "task": "3a1f", "type": "standard" } ], "error": [ { "task": "workflow_end", "type": "revert" }, { "task": "workflow_start", "type": "standard" } ] }, "serverId": "labore", "start_time": "1947-09-09T16:29:52.424Z", "end_time": -37895127.834649414, "finish_state": "failure", "retrySettings": null, "type": "operation", "actor": "job", "groups": [ "abc9677d62a0fffcf71c3521" ], "iterations": [ "Fc5d3d35-8a7f-e89B-4727-0254Ca63eA86" ] }, "a39": { "actor": "$var.job.1Z", "groups": [ "dba9f294106537bd5f536683", "183a6d7b7457109d5a4b3262", "default" ], "iterations": [], "x": 19796717.537446856, "y": -81522098.20842424, "gridCoordinate": { "x": -14875479.754183859, "y": 95184769.1495404 }, "name": "id minim nulla laborum", "location": "Application", "locationType": null, "app": "enim quis aute", "canvasName": "quis non pariatur aliqua", "displayName": "sunt quis aute", "summary": "voluptate", "description": "anim esse pariatur", "variables": { "error": "", "decorators": [ { "type": "encryption", "pointer": "/xV/pO0J-9Oc/~0/jxUPW1VZuS./Q5VM/gIz5oPE0XB/Nw" }, { "type": "encryption", "pointer": "/aVTXTZ+.Si" } ] }, "deprecated": false, "scheduled": true, "matched": [ { "key": "dolor in labore nisi", "highlightString": "minim commodo id" }, { "key": "magna", "highlightString": "in consequat dolor" } ], "status": "incomplete", "previous": { "incomplete": [ "workflow_end", "workflow_end" ], "complete": [ "workflow_end", "workflow_start", "3a1f" ], "error": [ "workflow_end", "workflow_end", "e28f", "workflow_start" ] }, "taskId": "error_handler", "transitions": { "success": [ { "task": "e28f", "type": "standard" }, { "task": "error_handler", "type": "loop" }, { "task": "error_handler", "type": "revert" } ], "failure": [ { "task": "e28f", "type": "standard" } ], "error": [ { "task": "3a1f", "type": "revert" }, { "task": "3a1f", "type": "loop" }, { "task": "workflow_start", "type": "revert" }, { "task": "workflow_start", "type": "revert" } ] }, "serverId": "occaecat proident", "start_time": "2018-03-13T15:22:58.026Z", "end_time": 94449325.56482214, "finish_state": "error", "retrySettings": null, "type": "automatic" } }, "parent": { "task": "in", "iteration": -92803214.88383421, "element": 29208865.394069374 }, "errorHandler": null, "groups": [ "default", "default", "default" ], "watchers": [ "Pronghorn", { "_id": "ce9de4e362b9a6ef9d68611b", "provenance": "ea sit cupidatat id enim", "username": "aliqua do fugiat amet anim", "firstname": "nostrud non sunt ut elit", "memberOf": [ { "groupId": "4134926ebec744ea6cdb3881", "aaaManaged": false }, { "groupId": "ffcbff86bad03c3a5ea85a2b", "aaaManaged": false }, { "groupId": "f58cd3fa3645397f4cf3e440", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "ut non" }, { "roleId": "et enim in mollit" }, { "roleId": "esse consequat labore pariatur Lorem" }, { "roleId": "officia sed aliqua culpa Excepteur" } ], "inactive": true, "lastLogin": "2017-02-25T10:19:21.037Z", "_meta": { "created": "1986-12-27T17:21:05.869Z", "updated": "1947-12-02T21:49:15.744Z", "migrationVersion": -82877837 }, "email": "labore minim exercitation dolore non" } ], "metrics": { "start_time": -61540406.31394855, "progress": 0.9731116980852261, "end_time": -23403318.768761754, "user": "fc0084c535b5f3bd46410a08", "owner": null } } }
{ "title": "job", "allOf": [ { "$ref": "common-api#/definitions/success-response" }, { "type": "object", "properties": { "data": { "$ref": "job-api" } } } ] }