Summary
Gets a page of task documents, bypassing GBAC.
Description
Gets a page of task documents, bypassing GBAC.
Route
GET /operations-manager/tasks
Roles
admin
engineering
apiread
operations
Parameters
Details Example Schema
Name
Type
Required
Description
queryParameters
object
yes
Parameters for filtering, paginating, projecting, and sorting task execution documents. For more information on how to use the search parameters for this API, see https://docs.itential.com/docs/search-api-4
Copied to Clipboard
{
"queryParameters": {
"limit": 1,
"skip": 1,
"order": 1,
"sort": "name",
"include": "name,description",
"exclude": "_id",
"in": "tempor magna in",
"not-in": "in voluptate fugiat",
"equals": "et tempor",
"contains": "tempor qui mollit",
"starts-with": "laboris amet adipisicing",
"ends-with": "nulla elit",
"dereference": "ex irure aliquip dolor Lorem",
"gt": "nisi",
"gte": "labore occaecat aute id aliquip",
"lt": "velit deserunt eiusmod do",
"lte": "eiusmod",
"q": "in"
}
}
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": "task-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."
}
}
}
