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": "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 imported 3 of 4 documents", "data": { "_id": "4fda9bd44f0b748e02b0d4af", "uuid": "bc9e5557-6a85-c306-82fb-6264c53584f8", "font_size": -32500383, "type": "automation", "created": "2008-05-19T21:37:03.134Z", "last_updated": "1972-03-13T04:41:37.104Z", "createdVersion": "0755766.88619184.3164-8905.50.4259.23692", "lastUpdatedVersion": "479.48595236.2465567-6194.804.1319016", "canvasVersion": 1, "encodingVersion": 1, "migrationVersion": -1688315, "name": "myCoolDocumentName", "description": null, "preAutomationTime": 56901313.0253095, "sla": 71538021.14729428, "decorators": [ { "type": "encryption", "pointer": "/~0/~1/~1/~0/H/-D/~1/~0" }, { "type": "encryption", "pointer": "/~0/XuCr/VBh9-fSU/qhjT/~1/nlNyYVmreRu" }, { "type": "encryption", "pointer": "/~0/~1/IFl/MpQK/wqkq4czk9lY/o-1Xjt/~1/~1/~0" }, { "type": "encryption", "pointer": "/~1/~1/~0/~0/~0/~0/nCiy/aR6-" }, { "type": "encryption", "pointer": "/~1/otJyis.JT" } ], "status": "incomplete", "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" }, { "task": "3a1f", "name": "myCoolDocumentName", "message": "pariatur esse anim consequat" }, { "task": "e28f", "name": "myCoolDocumentName" }, { "task": "workflow_start", "name": "myCoolDocumentName" } ], "ancestors": [ "02a387b226d4edebaca0e5be", "f515429f581e9edabfa22510" ], "validationErrors": [ { "keyword": "magna ut dolor", "instancePath": "commodo", "schemaPath": "in culpa exercitation laboris", "message": "non ea sed mollit laboris" }, { "keyword": "sit non esse ex do", "instancePath": "Duis amet voluptate", "schemaPath": "culpa non", "message": "mollit reprehenderit magna fugiat dolor" }, { "keyword": "Lorem amet ut Excepteur fugiat", "instancePath": "in proident sed eiusmod", "schemaPath": "eiusmod", "message": "sint irure culpa dolore id" }, { "keyword": "nulla tempor adipisicing ullamco", "instancePath": "eiusmod dolore non", "schemaPath": "Excepteur do fugiat", "message": "labore non" }, { "keyword": "commodo amet ullamco sunt cillum", "instancePath": "aute irure", "schemaPath": "do non voluptate eiusmod", "message": "dolore Lorem proident" } ], "created_by": { "_id": "b53fde7c56119c7880c4b4bb", "provenance": "tempor", "username": "ut id sint voluptate occaecat", "firstname": "amet aute", "memberOf": [ { "groupId": "c153384d94b7fb4a92c68d34", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "incididunt ipsum eu ullamco" }, { "roleId": "dolor do elit" } ], "inactive": false, "lastLogin": "1968-02-19T16:05:11.303Z", "_meta": { "created": "1973-10-11T22:46:04.081Z", "updated": "1965-11-27T21:49:48.652Z", "migrationVersion": -7000221 }, "email": "tempor eu nulla labore" }, "last_updated_by": "5355ac7dff85148d4b597ce2", "tasks": { "workflow_start": { "x": 68529319.84464994, "y": 83806349.50799796, "gridCoordinate": { "x": 16759131.174295396, "y": -31661886.516658604 }, "name": "workflow_start", "summary": "workflow_start", "taskId": "workflow_start", "metrics": { "start_time": -2866046.8846314102, "finish_state": "success", "user": "Pronghorn" }, "groups": [ { "_id": "dfc5318fffd34db266429a2f", "provenance": "dolore sunt consectetur Excepteur", "name": "nisi", "description": "ut laborum dolore", "memberOf": [ { "groupId": "ec61fe70213fd96bdd66352e", "aaaManaged": false }, { "groupId": "fae1441801058657792b3fd7", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "ea in magna velit commodo" }, { "roleId": "aliquip Excepteur deserunt sit laborum" }, { "roleId": "aliqua" }, { "roleId": "fugiat sunt dolor" }, { "roleId": "ea" } ], "inactive": false, "_meta": { "created": "2016-02-14T20:06:16.29Z", "updated": "1970-01-01T00:53:20.914Z", "migrationVersion": 78656228 } }, { "_id": "52da98e9d137dc6d3fa2fc1d", "provenance": "pariatur in ut", "name": "magna ullamco laboris quis qui", "description": "ullamco incididunt amet cupidatat", "memberOf": [ { "groupId": "f5e1ebc223a3c030707c0cee", "aaaManaged": true }, { "groupId": "51020d1a8bed3b2ed524419e", "aaaManaged": false }, { "groupId": "e654d3b915db277cf67bd02a", "aaaManaged": false }, { "groupId": "d0530102cb0fbf2272d2e9b3", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "irure" }, { "roleId": "in" }, { "roleId": "aliqua cillum in ut ea" }, { "roleId": "elit" } ], "inactive": true, "_meta": { "created": "1992-07-27T21:04:58.934Z", "updated": "1956-01-07T04:45:16.074Z", "migrationVersion": 87139997 } }, { "_id": "a223925cb06b82983a317d83", "provenance": "amet cupidatat tempor", "name": "do dolor laboris reprehenderit", "description": "esse", "memberOf": [ { "groupId": "db6b920f8011a47c5f2e69ab", "aaaManaged": false }, { "groupId": "42ea0bda221b2653d26c8173", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "minim" }, { "roleId": "labore minim Excepteur mollit" }, { "roleId": "reprehenderit ipsum magna aliquip" } ], "inactive": false, "_meta": { "created": "1958-01-06T10:07:30.535Z", "updated": "1992-04-12T17:17:57.414Z", "migrationVersion": 15262202 } } ], "iterations": [] }, "workflow_end": { "x": -78348225.86041738, "y": 2606159.355974078, "gridCoordinate": { "x": 4859345.997575164, "y": -61973879.138972476 }, "name": "workflow_end", "summary": "workflow_end", "taskId": "workflow_end", "endTasks": { "incomplete": [ "workflow_start", "workflow_start", "workflow_end", "3a1f" ], "complete": [ "workflow_end", "workflow_end", "e28f", "workflow_start" ], "error": [ "e28f", "e28f", "error_handler", "workflow_start", "3a1f" ] }, "metrics": { "end_time": -90349727.8562845, "run_time": 4188068.9694703966 }, "groups": [ { "_id": "4ca3edc52731d7dd24899a56", "provenance": "do magna", "name": "in cupidatat", "description": "officia esse", "memberOf": [ { "groupId": "f226129d467214f9fbd7b1cd", "aaaManaged": false }, { "groupId": "012d0406b6c64789ace5dae9", "aaaManaged": false }, { "groupId": "cee778549b59e34c3a6fc69e", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "aute aliqua ut occaecat incididunt" }, { "roleId": "dolor laborum Excepteur" }, { "roleId": "Lorem ea" }, { "roleId": "sed eu ea pariatur ullamco" } ], "inactive": true, "_meta": { "created": "1998-04-11T20:03:27.532Z", "updated": "1964-03-08T06:37:52.428Z", "migrationVersion": 26375419 } } ], "iterations": [ "D63A0BC5-bcf3-DBBa-C45B-72D8c1C50D40", "e79E3EAF-C0F4-a3aF-a375-6E1cb7aFaDc7", "75c78dcF-b858-760E-099f-5E6C0DF9C6a0" ] }, "error_handler": { "x": 20642084.92328708, "y": -95434099.81674165, "gridCoordinate": { "x": 89168904.03514454, "y": -58113781.779962495 }, "name": "childJob", "location": "Application", "locationType": null, "app": "sunt dolore", "canvasName": "laborum adipisicing anim irure", "displayName": "dolore nulla ea", "summary": "et", "description": "in aute incididunt sit", "variables": { "error": "", "decorators": [ { "type": "encryption", "pointer": "/~1" }, { "type": "encryption", "pointer": "/~0" }, { "type": "encryption", "pointer": "/EdWtgtgpz8/~1/v6WL2Q.sJQY/w+iAhXQ6w/~0/pw7s" } ] }, "deprecated": true, "scheduled": true, "matched": [ { "key": "in est enim", "highlightString": "et do velit" }, { "key": "id sint", "highlightString": "dolor non labore aliquip qui" }, { "key": "dolor id Excepteur eiusmod est", "highlightString": "do ullamco pariatur" }, { "key": "ipsum non incididunt elit", "highlightString": "in do ad esse" } ], "status": "paused", "previous": { "incomplete": [ "e28f", "workflow_start", "workflow_start" ], "complete": [ "workflow_start", "error_handler", "e28f", "workflow_start" ], "error": [ "3a1f", "error_handler", "error_handler", "3a1f" ] }, "taskId": "workflow_end", "transitions": { "success": [ { "task": "workflow_start", "type": "standard" }, { "task": "e28f", "type": "revert" } ], "failure": [ { "task": "workflow_start", "type": "loop" }, { "task": "workflow_start", "type": "standard" }, { "task": "e28f", "type": "standard" }, { "task": "workflow_start", "type": "standard" } ], "error": [ { "task": "workflow_start", "type": "standard" }, { "task": "e28f", "type": "loop" }, { "task": "workflow_start", "type": "standard" } ] }, "serverId": "ullamco voluptate consectetur mollit reprehenderit", "start_time": "1979-12-29T02:22:15.753Z", "end_time": -2568891.248786226, "finish_state": "failure", "retrySettings": { "state": [ "failure", "failure", "failure", "success" ], "autoRetry": true, "limit": 66336768, "delay": 55207440, "count": 80313682, "finishedRetrying": true }, "type": "operation", "actor": "job", "groups": [ "211765b787f2beab3521a432" ], "iterations": [ "597a1CfF-E0F2-95d2-0D6c-70ffFfFFf7F7", "7caC9C3c-a41d-6eBe-ebcB-f8FA1720455a", "16A7dade-9a9e-DAe8-aDAa-7b9E25F6Be4B" ] }, "de7d": { "actor": "Pronghorn", "groups": [ "default", { "_id": "70e788621c84236c8462f1fd", "provenance": "sint sed Lorem ad", "name": "qui laborum eu dolor", "description": "ullamco ut", "memberOf": [ { "groupId": "c155c6eab57e7cd8423fd33c", "aaaManaged": true }, { "groupId": "84043f7d99b2682fd498b195", "aaaManaged": true }, { "groupId": "3875d28cf5afa3246912888d", "aaaManaged": false }, { "groupId": "610021f02313ad8a1c22aa49", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "ut deserunt" }, { "roleId": "mollit sint aute" }, { "roleId": "nisi elit in minim" } ], "inactive": true, "_meta": { "created": "2015-02-12T10:41:26.261Z", "updated": "1954-04-07T02:18:07.967Z", "migrationVersion": -11911232 } } ], "iterations": [], "x": -43298692.06383692, "y": -383810.7779600322, "gridCoordinate": { "x": -63912176.53633863, "y": -39069545.12877365 }, "name": "Excepteur dolor elit enim dolor", "location": "Adapter", "locationType": null, "app": "laborum elit Duis quis", "canvasName": "consequat minim ut aliquip", "displayName": "ut", "summary": "Lorem", "description": "veniam", "variables": { "error": "", "decorators": [ { "type": "encryption", "pointer": "/~1/egT/~1/N8-izi3" }, { "type": "encryption", "pointer": "/~1/cX0B/~1" }, { "type": "encryption", "pointer": "/b8P2" } ] }, "deprecated": true, "scheduled": true, "matched": [ { "key": "do exercitation esse sint dolore", "highlightString": "est ad nostrud non sed" } ], "status": "paused", "previous": { "incomplete": [ "3a1f", "workflow_start", "error_handler", "3a1f", "workflow_start" ], "complete": [ "error_handler", "3a1f", "workflow_start" ], "error": [ "error_handler", "e28f", "error_handler" ] }, "taskId": "e28f", "transitions": { "success": [ { "task": "error_handler", "type": "standard" } ], "failure": [ { "task": "workflow_start", "type": "standard" } ], "error": [ { "task": "e28f", "type": "revert" }, { "task": "workflow_start", "type": "revert" }, { "task": "workflow_end", "type": "revert" } ] }, "serverId": "in", "start_time": "1958-08-05T21:00:50.775Z", "end_time": -10935249.155836195, "finish_state": "error", "retrySettings": { "state": [ "success", "failure", "error", "error" ], "autoRetry": true, "limit": 52623330, "delay": 68145344, "count": 58628449, "finishedRetrying": false }, "type": "automatic" } }, "parent": { "job": "qui dolore irure in reprehenderit", "task": "ut Ut ullamco cupidatat", "iteration": -46045443.13689028, "element": -18267059.58785966 }, "errorHandler": { "actor": "Pronghorn", "groups": [ "d57a40ae2b7c3db88d701c5b", { "_id": "46899c12d26053e39f06d111", "provenance": "dolore sit adipisicing", "name": "ut", "description": "in", "memberOf": [ { "groupId": "d19c079e1d6b605bc7791de5", "aaaManaged": true }, { "groupId": "fcbab10f8e1a2d8289d42ac5", "aaaManaged": false }, { "groupId": "b640c10997ed0e728c76355f", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "consequat et ad" } ], "inactive": true, "_meta": { "created": "2004-11-03T08:35:40.932Z", "updated": "2002-09-11T07:38:40.232Z", "migrationVersion": 51649852 } }, "default" ], "iterations": [ "BafaCBd6-866A-d0B9-17Fb-9F9CF3e2D9ee" ], "x": -65225335.6288989, "y": -85222206.04972133, "gridCoordinate": { "x": -49610204.0622147, "y": -97271216.61714496 }, "name": "tempor Duis non labore", "location": "Application", "locationType": "non incididunt pariatur", "app": "pariatur proident cupidatat", "canvasName": "in", "displayName": "aliqua Lorem eiusmod", "summary": "consectetur", "description": "ut enim cupidatat", "variables": { "error": "", "decorators": [ { "type": "encryption", "pointer": "/~1/QlJ/~1/oZ7RWPltOEM/Ui+D" }, { "type": "encryption", "pointer": "/~1/~1/~1/CM/vCRwdn/~0/~0/~0/x,P/~1/tgti9" }, { "type": "encryption", "pointer": "/~1/MLNr/~1" }, { "type": "encryption", "pointer": "/Hm3,w-n/O8WpXk5.4/WNX9Uxe6s/~0/C" }, { "type": "encryption", "pointer": "/~0/~0" } ] }, "deprecated": true, "scheduled": false, "matched": [ { "key": "sit cillum sint aliqua minim", "highlightString": "cillum amet aute" }, { "key": "ex", "highlightString": "laborum" }, { "key": "aliqua mollit voluptate nostrud", "highlightString": "in nisi tempor magna incididunt" } ], "status": "canceled", "previous": { "incomplete": [ "workflow_end", "3a1f", "3a1f", "workflow_end", "error_handler" ], "complete": [ "workflow_start", "workflow_start", "3a1f", "workflow_start", "workflow_start" ], "error": [ "workflow_start" ] }, "taskId": "e28f", "transitions": { "success": [ { "task": "3a1f", "type": "revert" }, { "task": "error_handler", "type": "revert" } ], "failure": [ { "task": "e28f", "type": "revert" }, { "task": "error_handler", "type": "standard" } ], "error": [ { "task": "e28f", "type": "standard" }, { "task": "3a1f", "type": "standard" } ] }, "serverId": "occaecat", "start_time": "1979-02-21T15:10:03.743Z", "end_time": 94192209.58661473, "finish_state": "failure", "retrySettings": null, "type": "automatic" }, "groups": [ "default", { "_id": "65f494666070c73fa0c4261f", "provenance": "ipsum id", "name": "deserunt", "description": "anim qui Ut amet", "memberOf": [ { "groupId": "6671bb5b3197d79522e9fe15", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "Excepteur ex voluptate" }, { "roleId": "in id" }, { "roleId": "mollit ipsum tempor do Excepteur" } ], "inactive": true, "_meta": { "created": "2003-04-03T19:32:47.502Z", "updated": "1996-10-27T16:55:44.544Z", "migrationVersion": -57026026 } }, "68e6e6e0357f8f288fa6f184", "default", "default" ], "watchers": [ "Pronghorn", null, "Pronghorn", null, null ], "metrics": { "start_time": -32349157.03443986, "progress": 0.8930206640449252, "end_time": 22464398.927581802, "user": null, "owner": "997b1bffecb3551f2773b0f0" } } }
{ "title": "job", "allOf": [ { "$ref": "common-api#/definitions/success-response" }, { "type": "object", "properties": { "data": { "$ref": "job-api" } } } ] }