Summary
Get a task by ID
Description
Get a task by ID. Include or exclude fields with the 'include' and 'exclude' parameters. Dereference foreign references with the 'dereference' parameter. Note on dereference parameter: 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'.
Route
GET /operations-manager/tasks/:id
Roles
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| id | string | yes | ObjectId specifying a task. |
| queryParameters | object | yes | Optional parameters for projecting fields in the task document. |
Return
| Name | Type | Description |
|---|---|---|
| task | object | Job document |