Summary
Gets Tasks
Description
Search the Task collection.
Route
GET /operations-manager/tasks
Roles
Parameters
Name | Type | Required | Description |
---|---|---|---|
queryParameters | object | yes | The query parameters available for this method. |
{ "queryParameters": { "limit": 10, "skip": 50, "order": 1, "sort": "name", "include": "name", "exclude": "description", "in": "ex laborum id adipisicing", "not-in": "occaecat sint veniam enim eiusmod", "equals": "ex cillum non", "contains": "voluptate", "starts-with": "dolor id in", "ends-with": "fugiat nulla adipisicing incididunt", "dereference": "ipsum veniam", "gt": "sed dolor sint incididunt", "gte": "aliqua", "lt": "occaecat id ad", "lte": "voluptate laborum ea aute dolor", "q": "anim consequat velit Duis", "actionableTasks": false } }
{ "type": "object", "properties": { "queryParameters": { "title": "queryParameters", "type": "object", "properties": { "limit": { "type": "integer", "description": "Number of results to return. Used for pagination.", "default": 25, "minimum": 0, "examples": [ 1, 10, 50 ] }, "skip": { "type": "integer", "description": "Number of results to skip. Used for pagination.", "default": 0, "minimum": 0, "examples": [ 1, 10, 50 ] }, "order": { "type": "integer", "description": "Sort direction, 1 for ascending and -1 for descending.", "default": 1, "enum": [ -1, 1 ] }, "sort": { "type": "string", "description": "Field to sort by", "default": "name", "enum": [ "name" ] }, "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" ] }, "in": { "description": "Search for fields exactly matching one of the given list options", "type": "string" }, "not-in": { "description": "Search for fields not exactly matching one of the given list options", "type": "string" }, "equals": { "description": "Returns results where the specified fields exactly match the given match string(s).", "type": "string" }, "contains": { "description": "Returns results where the specified fields contain the given match string(s).", "type": "string" }, "starts-with": { "description": "Returns results where the specified fields start with the given match string(s).", "type": "string" }, "ends-with": { "description": "Returns results where the specified fields end in the given match string(s).", "type": "string" }, "dereference": { "description": "Designates foreign key fields to dereference in the API output.", "type": "string" }, "gt": { "description": "Returns results where the specified fields have values greater than the specified values.", "type": "string" }, "gte": { "description": "Returns results where the specified fields have values greater than or equal to the specified values.", "type": "string" }, "lt": { "description": "Returns results where the specified fields have values less than the specified values.", "type": "string" }, "lte": { "description": "Returns results where the specified fields have values less than or equal to the specified values.", "type": "string" }, "q": { "description": "Accepts a full query expression as a URL-encoded JSON object. Supports all other query operators, in addition to logical conjunction with 'and', disjunction with 'or', and negation with 'not'. May be combined with other top-level operators.", "type": "string" }, "actionableTasks": { "type": "boolean", "description": "If true, only returns actionable tasks that the current user has write access to.", "default": false } } } }, "required": [ "queryParameters" ], "additionalProperties": false }
Return
Name | Type | Description |
---|---|---|
result | object | The Tasks that matched the search query. |
{ "message": "Successfully retrieved search results", "data": [ { "_id": "aED036c3-2Efe-1fA2-4eD2-9070dBEADfEC", "location": "Application", "view": "irure exercitation laboris amet", "status": "incomplete", "app": "sed", "name": "do Ut nostrud sunt", "variables": { "decorators": [ { "type": "encryption", "pointer": "/~0" }, { "type": "encryption", "pointer": "/~0/TQC50LleH/KfuWkK.rbYI/~0/L/he2ab/crc/~1" }, { "type": "encryption", "pointer": "/~0/fa3AMk/~1/~1/~0/~0/~0/F1loARg/~0/~1" } ] }, "last_updated": "1955-06-29T03:51:52.106Z", "encodingVersion": 1, "job": { "_id": "2fe12ed1096d2ceddfad1dfd", "task": "e28f", "name": "myCoolDocumentName", "description": "Some helpful information about the document", "ancestors": [ "e7cc94dd5630f9e080d1ec33" ] }, "incomingRefs": [], "groups": [ "28b3d21287161d158ebc2c4e" ], "type": "automatic", "metrics": { "start_time": "Lorem sint labore quis", "end_time": -67888744.91472888, "server_id": "veniam amet Lorem", "finish_state": "success", "run_time": 17408662.121293306, "retrying": false, "user": "e75be57704885578638cc93f", "owner": "5b255bb944f12f07f1a41858" } } ], "metadata": { "skip": -21181673, "limit": -78489777, "total": -39004861, "nextPageSkip": null, "previousPageSkip": -43236857, "currentPageSize": -17307327 } }
{ "title": "result", "allOf": [ { "$ref": "common-api#/definitions/success-response" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "task-api" } }, "metadata": { "$ref": "common-api#/definitions/pagination-metadata" } } } ] }