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", "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 created the requested item", "data": { "_id": "d9c7c378f0c417930dbfc06e", "font_size": 2645398, "type": "resource:action", "created": "1950-12-24T19:30:26.858Z", "last_updated": "2016-03-05T23:52:29.464Z", "createdVersion": "8473019.40886.83616-3085.226981.07175299632.3", "lastUpdatedVersion": "846965.121.7", "canvasVersion": 2, "encodingVersion": 1, "migrationVersion": -65608482, "name": "myCoolDocumentName", "description": "Some helpful information about the document", "preAutomationTime": -31994619.612503335, "sla": 33197186.461689964, "decorators": [ { "type": "encryption", "pointer": "/GQ6H0N/~1/Wia" }, { "type": "encryption", "pointer": "/o//gRkYE/~1/EPfF2u/O5Q" }, { "type": "encryption", "pointer": "/QKraWFObGR4/~1/~0/KWvEpR2LB/Qb/~0" } ], "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 } ], "warnings": [ { "task": "error_handler", "name": "myCoolDocumentName" } ], "ancestors": null, "validationErrors": [ { "keyword": "elit ipsum nulla", "dataPath": "fugiat", "schemaPath": "pariatur nisi velit", "message": "pariatur reprehenderit sit esse" }, { "keyword": "dolor irure", "dataPath": "consequat", "schemaPath": "ut", "message": "tempor sed" }, { "keyword": "Duis eiusmod dolore Ut incididunt", "dataPath": "consectetur aliqua exercitation", "schemaPath": "consectetur", "message": "dolore eu consequat commodo deserunt" }, { "keyword": "amet quis laboris", "dataPath": "esse enim ex", "schemaPath": "nulla id mollit ea", "message": "nisi et Lorem nostrud laborum" } ], "created_by": "5be75d2ac390bad259769803", "last_updated_by": "Pronghorn", "tasks": { "workflow_start": { "x": -19939496.606190324, "y": 18866048.613645643, "gridCoordinate": { "x": 60802674.92035222, "y": -87195797.43084309 }, "name": "workflow_start", "summary": "workflow_start", "taskId": "workflow_start", "metrics": { "start_time": -59781819.678032026, "finish_state": "success", "user": "d3df90dd436b984257065774" }, "groups": [ "83ff8aaa6aafa0fb9adbdbef", { "_id": "4966087277a281f2694111cf", "provenance": "non consequat", "name": "Ut quis ad", "description": "Lorem velit elit est pariatur", "memberOf": [ { "groupId": "c895ed5c47029fc1bcfee6b1", "aaaManaged": true }, { "groupId": "7e9c71dfbc8fe24aa8a400f4", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "Lorem esse ullamco" }, { "roleId": "Duis Excepteur aute ad" }, { "roleId": "non minim est" }, { "roleId": "deserunt fugiat consectetur Duis labore" }, { "roleId": "ea consequat dolor laborum" } ], "inactive": true, "_meta": { "created": "1961-11-15T04:51:48.982Z", "updated": "1972-01-24T09:24:58.454Z", "migrationVersion": 41293760 } } ], "iterations": [ "4f7813ec-DD3b-b89d-2d1B-0Ce7EA1aaBAe" ] }, "workflow_end": { "x": -37416565.179706484, "y": 52608636.97182301, "gridCoordinate": { "x": 47282350.746183395, "y": -53681636.720931806 }, "name": "workflow_end", "summary": "workflow_end", "taskId": "workflow_end", "endTasks": { "incomplete": [ "workflow_start", "workflow_start", "workflow_start", "workflow_start", "e28f" ], "complete": [ "e28f", "workflow_start" ], "error": [ "workflow_end", "workflow_start", "e28f", "workflow_start" ] }, "metrics": { "end_time": 54086532.59890276, "run_time": -1446160.3054986745 }, "groups": [ { "_id": "6eb900c74e6af36afbfb576b", "provenance": "aliquip mollit proident Duis", "name": "anim id mollit", "description": "pariatur", "memberOf": [ { "groupId": "e8b37fb6d445ba937205204f", "aaaManaged": true }, { "groupId": "f3760a057d9a465918fa48ac", "aaaManaged": true }, { "groupId": "9165f484b2456798456a4677", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "nisi voluptate non" }, { "roleId": "aliquip" }, { "roleId": "ipsum reprehenderit nisi Lorem Excepteur" }, { "roleId": "proident magna non Ut nisi" } ], "inactive": false, "_meta": { "created": "1951-04-30T08:40:39.743Z", "updated": "2015-12-18T02:07:58.782Z", "migrationVersion": -58672672 } } ], "iterations": [ "0aE8cBCC-bC42-307d-6F5D-cEbEe601DE9A", "eaB4cdf1-bfdD-8E1e-1ece-b44aa69ffc04", "6b2d9Ca1-0f64-EA05-98a5-107D8Dc0E5B1" ] }, "error_handler": { "x": 71288913.37073147, "y": -11440095.793276846, "gridCoordinate": { "x": 25700842.610863045, "y": -48793888.788384795 }, "name": "childJob", "location": "Application", "locationType": null, "app": "anim ea qui nostrud sunt", "canvasName": "aute", "displayName": "in qui laborum", "summary": "sed enim minim", "description": "pariatur aliqua sint ad laborum", "variables": { "error": "", "decorators": [ { "type": "encryption", "pointer": "/Gu" }, { "type": "encryption", "pointer": "/Q/PK/NZpLWC/yy/~0/~0/~0/njlLI/O/qfZkVUC3Y" } ] }, "deprecated": false, "scheduled": false, "matched": [ { "key": "in officia sunt", "highlightString": "proident sint exercitation id enim" }, { "key": "mollit sint culpa", "highlightString": "adipisicing ut eu in mollit" }, { "key": "est nulla occaecat", "highlightString": "dolore pariatur eiusmod irure" }, { "key": "do sit esse fugiat", "highlightString": "laborum" } ], "status": "incomplete", "previous": { "incomplete": [ "workflow_start" ], "complete": [ "3a1f", "workflow_start", "workflow_start", "3a1f" ], "error": [ "workflow_start", "workflow_end", "workflow_start", "error_handler" ] }, "taskId": "workflow_start", "transitions": { "success": [ { "task": "workflow_start", "type": "revert" } ], "failure": [ { "task": "workflow_start", "type": "standard" }, { "task": "workflow_end", "type": "standard" }, { "task": "error_handler", "type": "loop" }, { "task": "workflow_start", "type": "loop" }, { "task": "workflow_start", "type": "loop" } ], "error": [ { "task": "workflow_start", "type": "revert" }, { "task": "workflow_start", "type": "revert" }, { "task": "e28f", "type": "standard" }, { "task": "3a1f", "type": "standard" } ] }, "serverId": "anim in", "start_time": "2005-10-15T01:00:03.31Z", "end_time": 13071136.326833382, "finish_state": "failure", "retrySettings": null, "type": "operation", "actor": "56054776767689775b23475a", "groups": [ "default", "default", "1d16749a64955241466b89ea", { "_id": "8426a2731775a871e9581021", "provenance": "laborum anim nisi sed sit", "name": "proident deserunt fugiat velit", "description": "dolore pariatur dolor culpa ut", "memberOf": [ { "groupId": "0478c47ae9f90887e42a1ba7", "aaaManaged": true }, { "groupId": "1dc705e57df1bd140ff252ac", "aaaManaged": false }, { "groupId": "ef96b1e1d01743433ff00d11", "aaaManaged": false }, { "groupId": "1e87be18f8e06c117af26b11", "aaaManaged": false }, { "groupId": "b5d8ce27e9021d42723af95f", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "dolor cillum" }, { "roleId": "veniam" }, { "roleId": "id" }, { "roleId": "officia" } ], "inactive": true, "_meta": { "created": "1961-08-18T21:09:17.511Z", "updated": "1999-01-27T12:39:20.069Z", "migrationVersion": -23607374 } }, "default" ], "iterations": [ "0f3C788E-fEE4-2f1d-A082-6abC9fcFf192", "063b82a0-B9Bb-6d1A-BD45-ed98C97c64e3", "Fcd24C6B-403f-d4aC-2d1e-0bdc48D98bbA" ] }, "d93a": { "actor": "$var.job.Iyj5lClim", "groups": [ "default", "b2b838bd7afbb46cc2de672a", "default" ], "iterations": [ "FaB0dbFa-FaFd-F8cf-Ddf7-AAeECC7cAcB3", "AC3dDe17-11ad-B701-9e9a-C48FdfD5Be1d" ], "x": -53123484.31861182, "y": 10014869.279583216, "gridCoordinate": { "x": 2380478.825300619, "y": 71375132.6949828 }, "name": "aliqua Lorem eiusmod", "location": "Application", "locationType": null, "app": "est dolor consectetur minim Ut", "canvasName": "pariatur", "displayName": "velit aliqua Duis", "summary": "velit quis consectetur esse ut", "description": "ea aute et", "variables": { "error": "", "decorators": [ { "type": "encryption", "pointer": "/j,nymx" }, { "type": "encryption", "pointer": "/~0/~0/EhuUOcsk0w/Kbp89k-jCq/~1/b2" }, { "type": "encryption", "pointer": "/ekT6/gG8HLJNQz/fmoNWEOH/C0PT62K-/~1" }, { "type": "encryption", "pointer": "/~1/~0/~0/DESuGHW/v.bn14c/~0/~0/~0/~1/~1/~0" }, { "type": "encryption", "pointer": "/~1" } ] }, "deprecated": false, "scheduled": true, "matched": [ { "key": "eu dolor veniam ut", "highlightString": "aute dolore fugiat laborum cillum" }, { "key": "reprehenderit Duis", "highlightString": "Duis" }, { "key": "sint ullamco consequat et", "highlightString": "irure cillum" }, { "key": "ut", "highlightString": "aute id sunt voluptate" } ], "status": "running", "previous": { "incomplete": [ "workflow_start" ], "complete": [ "e28f", "3a1f", "workflow_end", "workflow_start" ], "error": [ "workflow_end", "error_handler", "workflow_start", "workflow_end", "error_handler" ] }, "taskId": "e28f", "transitions": { "success": [ { "task": "workflow_end", "type": "revert" }, { "task": "workflow_end", "type": "revert" } ], "failure": [ { "task": "workflow_start", "type": "loop" }, { "task": "workflow_start", "type": "revert" }, { "task": "workflow_start", "type": "loop" } ], "error": [ { "task": "workflow_start", "type": "revert" }, { "task": "3a1f", "type": "standard" }, { "task": "workflow_start", "type": "revert" }, { "task": "workflow_start", "type": "standard" }, { "task": "e28f", "type": "standard" } ] }, "serverId": "culpa dolor aliquip labore", "start_time": "1985-04-12T01:09:17.466Z", "end_time": 67579433.18616143, "finish_state": "error", "retrySettings": { "state": [ "success", "error" ], "autoRetry": false, "limit": 13456945, "delay": 26511353, "count": 29528810, "finishedRetrying": false }, "type": "automatic" } }, "parent": { "task": "non in", "iteration": -4157261.8587109, "element": -37392064.9046199 }, "errorHandler": null, "groups": [ "default", "default" ], "watchers": [ "ff411bf101070331d11fc072", null, { "_id": "5d75020d0863835b2dbe2047", "provenance": "dolore dolore elit", "username": "sint", "firstname": "mollit Ut", "memberOf": [ { "groupId": "227d2001e9eb7da1c6986c11", "aaaManaged": true }, { "groupId": "a432ecb4b92a4d30702524da", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "esse" }, { "roleId": "ut Lorem est qui" }, { "roleId": "proident" } ], "inactive": true, "lastLogin": "2011-01-28T00:37:54.659Z", "_meta": { "created": "1957-02-28T15:31:03.733Z", "updated": "1972-04-26T10:55:03.303Z", "migrationVersion": 85902205 }, "email": "aliquip ullamco" }, { "_id": "6ab693a42b98570d14fe72f3", "provenance": "id sed ad commodo consectetur", "username": "ut", "firstname": "aliqua qui", "memberOf": [ { "groupId": "9b609669fb9193d8dc66a0c9", "aaaManaged": false }, { "groupId": "3d0bcd19939a0c647c10784c", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "nisi labore nostrud tempor" }, { "roleId": "Excepteur" }, { "roleId": "ullamco enim" } ], "inactive": true, "lastLogin": "2017-08-20T13:55:51.827Z", "_meta": { "created": "1959-12-05T07:57:08.985Z", "updated": "1964-10-19T06:09:25.223Z", "migrationVersion": -48534601 }, "email": "occaecat in nostrud Ut" }, "1947993c0b95a26950073c43" ], "metrics": { "start_time": 3726941.4156784713, "progress": 0.009931755461962233, "end_time": -41081910.100966424, "user": null, "owner": "3716aa03d777e9a21b7a3ac7" } } }
{ "title": "job", "allOf": [ { "$ref": "common-api#/definitions/success-response" }, { "type": "object", "properties": { "data": { "$ref": "job-api" } } } ] }