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": 50, "skip": 0, "order": 1, "sort": "name", "include": "name,description", "exclude": "_id", "in": "nostrud non mollit pariatur", "not-in": "reprehenderit non velit qui in", "equals": "elit dolore reprehenderit", "contains": "incididunt labore ad est Duis", "starts-with": "id esse proident minim", "ends-with": "consequat ut adipisicing sed", "dereference": "fugiat", "gt": "velit irure", "gte": "reprehenderit", "lt": "ullamco", "lte": "in dolore", "q": "irure eu in nulla velit", "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 created the requested item", "data": [ { "_id": "67b64c5A-9e7b-3fc5-3EC7-be6CCDDd75aC", "location": "Broker", "view": "dolore veniam quis velit aliqua", "status": "canceled", "app": "non ullamco occaecat fugiat", "name": "aliqua veniam commodo sunt in", "variables": { "decorators": [ { "type": "encryption", "pointer": "/~1/bO/~1/fa/~0/ah9PyZAfQdv/~0/Z/l++Ve/z1ENmbSd/KKYtSknTQne" } ] }, "last_updated": "1992-01-19T11:48:23.201Z", "encodingVersion": 1, "job": { "_id": "e3663d10d311391941b313bd", "task": "e28f", "name": "myCoolDocumentName", "description": "Some helpful information about the document", "ancestors": [ "8f058a704eccd50f866a7861", "c599ef62b4525899489ca7a2", "2c44099eb13099d089287417" ] }, "groups": [ { "_id": "8f554390fa0ddbecdb6b820b", "provenance": "Ut reprehenderit", "name": "officia aute sunt in nostrud", "description": "nostrud aute commodo ullamco veniam", "memberOf": [ { "groupId": "ea7094564912a693f617e342", "aaaManaged": true }, { "groupId": "800b8403ab0157f2a7a32e22", "aaaManaged": false }, { "groupId": "eecde38f672a4709ef486b5d", "aaaManaged": false }, { "groupId": "3a7ae4c6e5c18dd1c01de7cb", "aaaManaged": true }, { "groupId": "4606b107d080922234d192ac", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "dolore tempor" } ], "inactive": false, "_meta": { "created": "1969-10-28T00:45:45.015Z", "updated": "2007-02-14T16:23:53.241Z", "migrationVersion": 1027513 } }, "f3f1b6c891b7164846e9198b" ], "type": "operation", "metrics": { "start_time": "anim ad mollit", "end_time": -78962557.78315137, "server_id": "dolor officia exercitation", "finish_state": "success", "run_time": 83704399.3926771, "retrying": true, "user": "831abbb7d7409abecb74c895", "owner": "" } }, { "_id": "DA9eFCe6-4EBa-F189-50a5-d4e835076f76", "location": "Broker", "view": "id consectetur qui", "status": "scheduled", "app": "nisi", "name": "in non adipisicing Ut veniam", "variables": { "decorators": [ { "type": "encryption", "pointer": "/~0/YrAbMJgS/~1/~0" }, { "type": "encryption", "pointer": "/ua/i" }, { "type": "encryption", "pointer": "/HaO..,A5/mw6lhtX/WBIFb,uqTj/~0/~0/p6.9WjwGUu/OBK-+IPPf/yflUe9z9Ga/xnv/h/Qj/CA7XG,D+/" } ] }, "last_updated": "1959-09-20T21:29:54.893Z", "encodingVersion": 1, "job": { "_id": "6a7850b013e107ab8a24eeb0", "task": "e28f", "name": "myCoolDocumentName", "description": "Some helpful information about the document", "ancestors": [ "a530ca422ed9361f65dc395b", "8ed64975ce472f956142a5cb", "fe7e04fab94e2a7e18ae5020", "86db1625aed446837220ec5e" ] }, "groups": [ { "_id": "bf14fe29f13abd21791f1e22", "provenance": "minim ex id", "name": "nostrud consectetur", "description": "officia dolor culpa irure aliqua", "memberOf": [ { "groupId": "e172337e328dd1e59151b685", "aaaManaged": false }, { "groupId": "eeddcb5c37ad49c6ee89d2bd", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "sit amet consectetur non tempor" }, { "roleId": "eu qui" } ], "inactive": true, "_meta": { "created": "1996-10-21T05:36:14.32Z", "updated": "1957-11-17T13:15:16.587Z", "migrationVersion": 61599691 } } ], "type": "operation", "metrics": { "start_time": "et", "end_time": 858031.8342194259, "server_id": "anim commodo consectetur nostrud", "finish_state": "success", "run_time": -89142103.68106747, "retrying": true, "user": "4020275514f6fec5cd02f1d4", "owner": "059af53fe3672f0b715f41fd" } } ], "metadata": { "skip": -51247220, "limit": 66052183, "total": 34086162, "nextPageSkip": -49083345, "previousPageSkip": -65091754, "currentPageSize": 76532444 } }
{ "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" } } } ] }