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,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 imported 3 of 4 documents", "data": { "_id": "efbd62f976b5c3e99c189516", "font_size": 73826973, "type": "automation", "created": "1948-12-01T19:58:06.842Z", "last_updated": "1968-04-09T06:45:55.958Z", "createdVersion": "1546283.86892.99015194", "lastUpdatedVersion": "716.78.2308580648", "canvasVersion": 1, "encodingVersion": 1, "migrationVersion": 15196276, "name": "myCoolDocumentName", "description": null, "preAutomationTime": -53777445.8009932, "sla": 33426813.583202675, "decorators": [ { "type": "encryption", "pointer": "/~0" }, { "type": "encryption", "pointer": "/S7h/.9E." }, { "type": "encryption", "pointer": "/Lh+LQWgky/jNHXX/~1/O.zmaShAG" } ], "status": "complete", "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": "3a1f", "name": "myCoolDocumentName", "message": "id aliqua Ut et" }, { "task": "workflow_end", "name": "myCoolDocumentName", "message": "commodo dolore sint Ut occaecat" }, { "task": "workflow_start", "name": "myCoolDocumentName" }, { "task": "e28f", "name": "myCoolDocumentName", "message": "officia aute nisi" } ], "ancestors": null, "validationErrors": [ { "keyword": "in", "dataPath": "elit", "schemaPath": "sint nisi", "message": "labore minim id" }, { "keyword": "irure", "dataPath": "aute ut nostrud", "schemaPath": "aliqua pariatur laboris ullamco Duis", "message": "incididunt commodo ipsum deserunt" } ], "created_by": "5d736fcdfe8895d362a9be2b", "last_updated_by": "Pronghorn", "tasks": { "workflow_start": { "x": -87752058.65754879, "y": 22487273.481796205, "gridCoordinate": { "x": 33266993.646873727, "y": -17197489.320941 }, "name": "workflow_start", "summary": "workflow_start", "taskId": "workflow_start", "metrics": { "start_time": 1566430.0921070874, "finish_state": "error", "user": null }, "groups": [ "default", "2b4c6f7f6c438c118bf87d7d", { "_id": "527ab594bebbbaf865ba488e", "provenance": "fugiat tempor esse id", "name": "ea", "description": "id sit enim non eu", "memberOf": [ { "groupId": "cc44774ba5c4ece854a62726", "aaaManaged": true }, { "groupId": "d8730fad6f1d2e19eefa1aa1", "aaaManaged": true }, { "groupId": "b59fcd08f24d203ca6d9a035", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "veniam dolor laborum" }, { "roleId": "qui labore officia elit" }, { "roleId": "irure pariatur ad" }, { "roleId": "nulla enim" }, { "roleId": "ipsum consectetur cillum Excepteur" } ], "inactive": true, "_meta": { "created": "1955-01-14T06:54:31.722Z", "updated": "1960-05-10T16:37:22.233Z", "migrationVersion": -90007657 } }, "default", "68bccfb4e14b7001f630d85e" ], "iterations": [ "4dDAAe5F-14De-860D-1ba1-4e4a216fA9a9" ] }, "workflow_end": { "x": -52175339.05278828, "y": 38915811.92908773, "gridCoordinate": { "x": 41531948.89188582, "y": 39571739.586303145 }, "name": "workflow_end", "summary": "workflow_end", "taskId": "workflow_end", "endTasks": { "incomplete": [ "3a1f", "workflow_end", "e28f", "3a1f", "error_handler" ], "complete": [ "3a1f" ], "error": [ "error_handler", "workflow_start" ] }, "metrics": { "end_time": -53948593.604924254, "run_time": 694147.6591308117 }, "groups": [ "89149fed7ebfb2cbcd3bf4a9", "370d5d2c1493f721ddfefb53", "8ed87660f7f3291073c260b3", { "_id": "088a473ac956f7e86bba2e4b", "provenance": "dolor cupidatat", "name": "ea fugiat", "description": "proident eiusmod sit", "memberOf": [ { "groupId": "bf38398cc13ec88ca7b5c8f7", "aaaManaged": false }, { "groupId": "04acaf4607a6f263acfbf6b1", "aaaManaged": true }, { "groupId": "55210a5b8b0de86124ccbf2f", "aaaManaged": false }, { "groupId": "515e6c930a6e494f95f13e00", "aaaManaged": false }, { "groupId": "154a5e510758026a6fe5ab38", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "consectetur non" }, { "roleId": "dolore adipisicing" }, { "roleId": "mollit dolore" }, { "roleId": "dolor cillum in magna aute" }, { "roleId": "ut" } ], "inactive": true, "_meta": { "created": "1962-07-23T20:17:36.721Z", "updated": "1997-12-20T05:19:35.292Z", "migrationVersion": -33520442 } } ], "iterations": [] }, "error_handler": { "x": 4059307.1875779927, "y": -18245203.8793305, "gridCoordinate": { "x": 84732223.89718083, "y": -85485187.44896092 }, "name": "childJob", "location": "Application", "locationType": "sunt Ut", "app": "reprehenderit", "canvasName": "occaecat ad", "displayName": "laboris in voluptate mollit", "summary": "elit ullamco", "description": "labore", "variables": { "error": "", "decorators": [ { "type": "encryption", "pointer": "/~1/s0tA,GSw0x/~0/~0/s" }, { "type": "encryption", "pointer": "/S4oK6Hx-./~0/~0/~1/MjP2/~1/~0/~1/A2" }, { "type": "encryption", "pointer": "/~0/~0/Xyc6PjvO7" } ] }, "deprecated": false, "scheduled": true, "matched": [ { "key": "voluptate dolore", "highlightString": "Lorem ipsum" } ], "status": "canceled", "previous": { "incomplete": [ "workflow_end", "e28f", "workflow_start", "3a1f", "error_handler" ], "complete": [ "3a1f" ], "error": [ "workflow_start" ] }, "taskId": "workflow_end", "transitions": { "success": [ { "task": "e28f", "type": "standard" } ], "failure": [ { "task": "error_handler", "type": "revert" } ], "error": [ { "task": "workflow_end", "type": "loop" }, { "task": "error_handler", "type": "loop" }, { "task": "workflow_start", "type": "revert" } ] }, "serverId": "elit sunt ad minim", "start_time": "1952-05-15T20:13:48.069Z", "end_time": -3763509.611229837, "finish_state": "error", "retrySettings": null, "type": "operation", "actor": "job", "groups": [ "default" ], "iterations": [] }, "af04": { "actor": "Pronghorn", "groups": [ { "_id": "8692aae6151a3cad82c799e1", "provenance": "officia magna consectetur anim", "name": "ex", "description": "quis sit deserunt laboris", "memberOf": [ { "groupId": "77d9516f809724d740db5ba0", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "irure dolore" }, { "roleId": "mollit officia culpa est" }, { "roleId": "occaecat velit commodo" }, { "roleId": "magna pariatur" } ], "inactive": false, "_meta": { "created": "1960-02-07T22:23:52.124Z", "updated": "1947-12-11T03:18:44.674Z", "migrationVersion": 37476741 } }, "default", "default", "1aed5c9c9dfb168e9368d945" ], "iterations": [ "9BA7E9Ae-878F-80ff-BA4a-77Deab261aaa" ], "x": 80249206.79317611, "y": -19526313.52438505, "gridCoordinate": { "x": 65833156.53506699, "y": 20981056.726214394 }, "name": "voluptate officia laboris cillum aute", "location": "Broker", "locationType": null, "app": "nostrud", "canvasName": "labore", "displayName": "esse sunt", "summary": "qui ut labore laboris", "description": "enim sed ut velit esse", "variables": { "error": "", "decorators": [ { "type": "encryption", "pointer": "/O/~0/Yr/yvi+yoa//~0/iek0F62hB4f" }, { "type": "encryption", "pointer": "/~1/h+/C" }, { "type": "encryption", "pointer": "/gZJl//pq1e01/oud.zWAL/~1/~0/~1/u-/gWEmBY/ottGK/a2YDI" } ] }, "deprecated": false, "scheduled": true, "matched": [ { "key": "officia mollit ea cupidatat", "highlightString": "nisi labore consequat" }, { "key": "dolor anim", "highlightString": "exercitation Lorem Excepteur in" }, { "key": "incididunt", "highlightString": "nostrud cupidatat qui do" }, { "key": "veniam", "highlightString": "est magna proident" }, { "key": "sint Excepteur", "highlightString": "aute ex proident consequat non" } ], "status": "complete", "previous": { "incomplete": [ "workflow_start", "workflow_start" ], "complete": [ "3a1f", "error_handler", "3a1f" ], "error": [ "error_handler", "error_handler" ] }, "taskId": "e28f", "transitions": { "success": [ { "task": "workflow_end", "type": "loop" }, { "task": "error_handler", "type": "standard" }, { "task": "error_handler", "type": "loop" }, { "task": "e28f", "type": "standard" } ], "failure": [ { "task": "workflow_end", "type": "standard" } ], "error": [ { "task": "e28f", "type": "revert" }, { "task": "workflow_start", "type": "standard" }, { "task": "e28f", "type": "revert" } ] }, "serverId": "mollit aute laborum", "start_time": "1962-10-16T14:31:35.705Z", "end_time": -79645095.89437446, "finish_state": "error", "retrySettings": { "state": [ "failure" ], "autoRetry": false, "limit": 65353157, "delay": 48700367, "count": 84665847, "finishedRetrying": true }, "type": "manual", "view": "tempor occaecat et" } }, "parent": { "job": "tempor ad", "task": "nulla veniam sit", "iteration": 4554467.692893118, "element": 62639724.04751268 }, "errorHandler": null, "groups": [ { "_id": "6636b3976f618f506be41cd9", "provenance": "ipsum irure", "name": "nostrud consectetur ipsum velit", "description": "Lorem elit", "memberOf": [ { "groupId": "1e7a9734a42a964b1cb200cc", "aaaManaged": false }, { "groupId": "fa0dea01097a74a72dffd38c", "aaaManaged": true }, { "groupId": "c7771cb9cc128a42c0af6f97", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "et" }, { "roleId": "est aliqua tempor" }, { "roleId": "anim" }, { "roleId": "sunt dolor in" } ], "inactive": true, "_meta": { "created": "1995-07-10T16:22:00.627Z", "updated": "1988-08-10T03:44:27.415Z", "migrationVersion": 1238360 } }, "default", "53e29a0181e60079478e522b", "default" ], "watchers": [ "Pronghorn", { "_id": "702412b3546ffc4790de6dfe", "provenance": "dolor", "username": "exercitation eiusmod reprehenderit veniam sunt", "firstname": "mollit", "memberOf": [ { "groupId": "7b1779dda0af72a2bb09e9e4", "aaaManaged": true }, { "groupId": "ad6431903a7796e5024ce7e3", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "et exercitation" }, { "roleId": "id eu adipisicing" }, { "roleId": "aliquip laborum ex" }, { "roleId": "nisi deserunt incididunt" }, { "roleId": "id" } ], "inactive": false, "lastLogin": "1948-07-27T19:00:10.798Z", "_meta": { "created": "1973-12-16T15:26:50.39Z", "updated": "2001-03-28T22:40:50.479Z", "migrationVersion": 22732793 }, "email": "culpa aliqua" }, "Pronghorn", { "_id": "206679db8302568d16db04cb", "provenance": "irure adipisicing non culpa veniam", "username": "enim Ut ea minim", "firstname": "nulla exercitation esse deserunt", "memberOf": [ { "groupId": "cfdbdcb9dcff9a0ea8beb1a2", "aaaManaged": true }, { "groupId": "54d1f6b5c16da5a7ec36a2f5", "aaaManaged": false }, { "groupId": "00808da3d6f256f62ffcc447", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "magna anim dolore elit pariatur" }, { "roleId": "officia minim" }, { "roleId": "quis ut minim" }, { "roleId": "et magna est ad eu" }, { "roleId": "consectetur in aute officia" } ], "inactive": true, "lastLogin": "2002-07-25T11:19:36.491Z", "_meta": { "created": "2000-03-11T05:57:41.381Z", "updated": "2023-06-04T11:40:18.146Z", "migrationVersion": -13738198 }, "email": "non veniam irure elit" }, "Pronghorn" ], "metrics": { "start_time": -24831778.063387632, "progress": 0.6264522471193685, "end_time": -74148657.77877249, "user": "85ba493c13f6c801065fd788", "owner": { "_id": "3c1ced4328e4dda3027752a9", "provenance": "Excepteur", "username": "in elit", "firstname": "consequat aliquip sint", "memberOf": [ { "groupId": "d7972fd34ff078c83d1405ad", "aaaManaged": true }, { "groupId": "9904df3b3f7920f8f5656106", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "quis occaecat culpa reprehenderit" }, { "roleId": "aliquip qui" } ], "inactive": false, "lastLogin": "1983-03-31T15:57:55.879Z", "_meta": { "created": "2001-09-24T07:33:45.281Z", "updated": "2014-09-26T18:49:29.86Z", "migrationVersion": -47294494 }, "email": "dolor est adipisicing nisi id" } } } }
{ "title": "job", "allOf": [ { "$ref": "common-api#/definitions/success-response" }, { "type": "object", "properties": { "data": { "$ref": "job-api" } } } ] }