Summary
Get a task by ID
Description
Get a Task.
Route
GET /operations-manager/tasks/:id
Roles
Parameters
Name | Type | Required | Description |
---|---|---|---|
id | string | yes | The id of the Task to get. |
queryParameters | object | yes | Optional parameters for projecting fields in the Task document. |
{ "queryParameters": { "include": "description", "exclude": "description", "dereference": "job" } }
{ "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. The main function of this parameter is to retrieve extra information on a task that would not ordinarily be included. If information is needed on the task's parent job, the dereference parameter may be given a value of 'job'. This will look up the full job document and place it under the 'job' property in the task document. If the output of a child job task is needed, the dereference parameter may be given a value of 'child-job-output'. This will look up the output of the job initiated by the child job task. If the child job has loop settings each individual output will be provided in an array under the property 'variables.outgoing.job_details.loop'. If the child job does not have loop settings, the output of the single job document will be provided under the property 'variables.outgoing.job_details.output'.", "examples": [ "job", "accounts.metrics.owner" ] } } } }, "required": [ "queryParameters" ], "additionalProperties": false }
Return
Name | Type | Description |
---|---|---|
task | object | The requested Task. |
{ "message": "Successfully retrieved search results", "data": { "_id": "d760DCff-C655-3aB5-0eb5-D856cAb9be7e", "location": "Application", "view": "ut reprehenderit irure", "status": "canceled", "app": "sunt consectetur", "name": "veniam dolore fugiat", "variables": { "decorators": [ { "type": "encryption", "pointer": "/IvJeEo+5/gS,qR/b.F/IER/OhsYkJ/y23C/~1/OeQNFSp10or/~1/~1" } ] }, "last_updated": "1965-07-18T21:25:25.667Z", "encodingVersion": 1, "job": { "_id": "68bb52d4789cd822b09cce11", "task": "b4f", "name": "myCoolDocumentName", "description": "Some helpful information about the document", "ancestors": [ "4c9d7a8b494feb24b3742c30", "221863b3bf2ced2ba705f76d" ] }, "incomingRefs": [], "groups": [ "9c059f1c4195591c4875c72f", "e14c69e4687cf83a583a5325", { "_id": "4ddc996fa8f7ed4a496d3295", "provenance": "nostrud eu", "name": "Duis magna", "description": "cupidatat dolor", "memberOf": [ { "groupId": "52e90704a02d3c38768ffa05", "aaaManaged": false }, { "groupId": "e085ac8000d5f7d3186a8c70", "aaaManaged": true }, { "groupId": "80fc4e3a91438007ea6e489b", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "ut Lorem do in et" }, { "roleId": "et quis ad fugiat" }, { "roleId": "Duis dolor incididunt cillum pariatur" }, { "roleId": "cillum deserunt est" } ], "inactive": true, "_meta": { "created": "1969-11-07T05:44:47.452Z", "updated": "1955-01-26T13:08:20.821Z", "migrationVersion": -33121082 } }, { "_id": "273a6489d6be34ec37450321", "provenance": "amet", "name": "adipisicing nostrud in sit est", "description": "Lorem", "memberOf": [ { "groupId": "607be6845b3b0a6034dec17b", "aaaManaged": false }, { "groupId": "4a4032dae3bbfb9c4f817ad6", "aaaManaged": false }, { "groupId": "8ca53cdbcd5a64893826f263", "aaaManaged": false }, { "groupId": "1b707284c2abdca6f5fe026a", "aaaManaged": false }, { "groupId": "edb65859519b5eab02d20e27", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "dolore tempor" }, { "roleId": "Excepteur irure reprehenderit ut in" }, { "roleId": "quis laboris veniam cupidatat" }, { "roleId": "laborum" }, { "roleId": "ullamco in Excepteur" } ], "inactive": true, "_meta": { "created": "1951-11-06T06:08:03.429Z", "updated": "1991-11-10T23:51:51.977Z", "migrationVersion": 9203507 } }, { "_id": "bad404820764f59ad8baf54d", "provenance": "nostrud", "name": "non qui", "description": "in", "memberOf": [ { "groupId": "306e2ed3ab9f4033936bb432", "aaaManaged": false }, { "groupId": "d32fe633183e783ecf3ae7bd", "aaaManaged": true }, { "groupId": "3f6a837b0832f33cc7f28889", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "eiusmod dolore" }, { "roleId": "nostrud eiusmod laboris et" }, { "roleId": "labore Excepteur in id aute" }, { "roleId": "ea in" } ], "inactive": false, "_meta": { "created": "1948-07-08T12:57:29.752Z", "updated": "1994-01-02T02:38:25.464Z", "migrationVersion": -89968965 } } ], "type": "automatic", "metrics": { "start_time": "dolor", "end_time": 1786679.1692912728, "server_id": "nisi ea sint ipsum dolore", "finish_state": "running", "run_time": -84587531.53225094, "retrying": null, "user": { "_id": "731bd603f0dfd90545c88687", "provenance": "do laborum ullamco enim", "username": "fugiat culpa", "firstname": "fugiat cillum culpa sunt", "memberOf": [ { "groupId": "67fd9160055eb19472d8c4cf", "aaaManaged": false }, { "groupId": "7f541614d4ed3ad37a63a676", "aaaManaged": true }, { "groupId": "dcf12d86fa1fa7298f268b24", "aaaManaged": false }, { "groupId": "eb30f3f417154831018d35f4", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "fugiat et" }, { "roleId": "enim aute cillum consequat" } ], "inactive": false, "lastLogin": "2018-08-11T15:59:55.432Z", "_meta": { "created": "1991-12-23T18:04:59.345Z", "updated": "1945-11-12T10:07:41.924Z", "migrationVersion": 8768391 }, "email": "enim eiusmod amet qui" }, "owner": "7520b79d121ebda60456abfb" } } }
{ "title": "task", "allOf": [ { "$ref": "common-api#/definitions/success-response" }, { "type": "object", "properties": { "data": { "$ref": "task-api" } } } ] }