Get a job by ID. Include or exclude fields with the 'include' and 'exclude' parameters. Dereference foreign references with the 'dereference' parameter.
Route
GET /operations-manager/jobs/:id
Roles
adminengineeringapireadoperations
Parameters
DetailsExampleSchema
Name
Type
Required
Description
id
string
yes
ObjectId specifying a job.
queryParameters
object
yes
Optional parameters for projecting fields in the job document.
{
"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
}
