Summary
Gets a page of job documents.
Description
Gets a page of job documents.
Route
GET /operations-manager/jobs
Roles
admin
engineering
apiread
operations
Parameters
DetailsExampleSchema
| Name |
Type |
Required |
Description |
| queryParameters |
object |
yes |
Parameters for filtering, paginating, projecting, and sorting job documents. |
Copied to Clipboard
{
"queryParameters": {
"limit": 25,
"skip": 0,
"order": 1,
"sort": "name",
"include": "description",
"exclude": "_id,description",
"in": "nisi ullamco",
"not-in": "esse ut dolore",
"equals": "magna qui non do",
"contains": "elit ex reprehenderit",
"starts-with": "Ut aliqua",
"ends-with": "Lorem non veniam",
"dereference": "ullamco",
"gt": "ut",
"gte": "ex irure in cupidatat dolor",
"lt": "sint non minim laborum Excepteur",
"lte": "Ut occaecat incididunt mollit sit",
"q": "non ex"
}
}
Return
DetailsExampleSchema
| Name |
Type |
Description |
| result |
object |
Results for the given search parameters. |
Copied to Clipboard
{
"result": true
}
Copied to Clipboard
{
"title": "result",
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "job-api"
}
},
"total": {
"type": "integer",
"description": "Total number of documents matching the given query parameters."
},
"currentPageSize": {
"type": "integer",
"description": "Total number of documents returned in the items array."
},
"hints": {
"type": "array",
"description": "List of messages containing helpful context-sensitive information",
"items": {
"type": "string"
}
},
"skip": {
"type": "integer",
"description": "Current skip value."
},
"limit": {
"type": "integer",
"description": "Current limit value."
},
"nextPageSkip": {
"type": "integer",
"description": "Value to use for skip to get next page of results."
},
"previousPageSkip": {
"type": "integer",
"description": "Value to use for skip to get previous page of results."
}
}
}
