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
Details Example Schema
Name
Type
Required
Description
queryParameters
object
yes
Parameters for filtering, paginating, projecting, and sorting job documents. For more information on how to use the search parameters for this API, see https://docs.itential.com/docs/search-api-1
Copied to Clipboard
{
"queryParameters": {
"limit": 10,
"skip": 1,
"order": 1,
"sort": "name",
"include": "name",
"exclude": "description",
"in": "ex sint",
"not-in": "in eu",
"equals": "occaecat qui quis do officia",
"contains": "pariatur id",
"starts-with": "tempor adipisicing Duis",
"ends-with": "dolore",
"dereference": "sed ipsum dolore ullamco",
"gt": "irure esse eu",
"gte": "Duis",
"lt": "anim",
"lte": "pariatur dolore",
"q": "tempor"
}
}
Return
Details Example Schema
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."
}
}
}
