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": 25, "skip": 50, "order": 1, "sort": "name", "include": "name,description", "exclude": "description", "in": "deserunt", "not-in": "sint elit culpa cupidatat", "equals": "aute", "contains": "magna do", "starts-with": "est magna", "ends-with": "exercitation dolor", "dereference": "amet fugiat consequat dolore velit", "gt": "magna Excepteur", "gte": "sunt labore esse in dolore", "lt": "sunt", "lte": "Excepteur", "q": "labore", "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": "dE720c2F-6Ad5-2eCA-45aD-F9ACe8AFCcBe", "location": "Adapter", "view": null, "status": "running", "app": "est Lorem Excepteur eu", "name": "sunt dolor fugiat nulla", "variables": { "decorators": [ { "type": "encryption", "pointer": "/~0/~1/~1/~1/Kx/~0/i/F5,d" }, { "type": "encryption", "pointer": "/~1/~0/~1" }, { "type": "encryption", "pointer": "/~0/~1/K/XRfJqCbvFk/~0" } ] }, "last_updated": "1972-02-24T18:17:15.46Z", "encodingVersion": 1, "job": { "_id": "e479f154761f0f316adc599d", "task": "b4f", "name": "myCoolDocumentName", "description": "Some helpful information about the document", "ancestors": null }, "incomingRefs": [], "groups": [ { "_id": "4e68ef2d78c51ab59506da52", "provenance": "incididunt et proident consectetur", "name": "cillum", "description": "amet sint aliqua", "memberOf": [ { "groupId": "1c4768cb57b26932e12e0b5a", "aaaManaged": false }, { "groupId": "852ca0329f3ac8a4c924650b", "aaaManaged": false }, { "groupId": "773631bd936cd8caf7230a11", "aaaManaged": true }, { "groupId": "9213be5946bbde6bc11ebb3f", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "voluptate" }, { "roleId": "sint" }, { "roleId": "commodo laborum" }, { "roleId": "in tempor dolor" }, { "roleId": "aliquip" } ], "inactive": false, "_meta": { "created": "1978-11-04T18:35:53.172Z", "updated": "2006-06-01T03:19:40.706Z", "migrationVersion": 144271 } }, { "_id": "ca5237d04918b3fc487c881c", "provenance": "enim ut", "name": "laboris in", "description": "ad nostrud anim", "memberOf": [ { "groupId": "8b30aeb7597243c702c57fa2", "aaaManaged": false }, { "groupId": "f291bbb144e50f0c8c5ec7a5", "aaaManaged": true }, { "groupId": "f4b0a7e408f62087adf3f93b", "aaaManaged": false }, { "groupId": "9fa4d1d7d99965bb8c362421", "aaaManaged": true }, { "groupId": "6637ea61fa53da020cd25ea4", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "incididunt ex aliquip" }, { "roleId": "laborum dolore veniam ex" }, { "roleId": "dolor" } ], "inactive": true, "_meta": { "created": "1986-09-12T10:53:32.044Z", "updated": "1975-10-01T01:16:39.122Z", "migrationVersion": -57163694 } }, { "_id": "3751273df47c65f0223229e9", "provenance": "tempor aliquip officia Ut minim", "name": "Lorem minim labore culpa", "description": "ut", "memberOf": [ { "groupId": "9d2a2bc8e37274efcf60680f", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "exercitation non" }, { "roleId": "ut aliqua" }, { "roleId": "esse mollit" } ], "inactive": false, "_meta": { "created": "1958-12-15T06:12:17.943Z", "updated": "2005-09-04T03:02:16.085Z", "migrationVersion": -2137353 } }, "24c12fa0687388984f123b2d" ], "type": "automatic", "metrics": { "start_time": "sunt Excepteur", "end_time": 5383212.825360805, "server_id": "aute laborum minim quis labore", "finish_state": "failure", "run_time": -29587745.64085202, "retrying": false, "user": "c74e229d97274d3e80184112", "owner": { "_id": "de28fa2518ccf5be41ee7263", "provenance": "ipsum quis nisi", "username": "incididunt", "firstname": "deserunt eu nisi ex", "memberOf": [ { "groupId": "006cbb7f5b5e3c52d92b1562", "aaaManaged": false }, { "groupId": "126fbaa7235daa3470632ea7", "aaaManaged": false }, { "groupId": "f366a704f82cbc031f5ea00d", "aaaManaged": true }, { "groupId": "347bfaaaa222268ac00f4886", "aaaManaged": true }, { "groupId": "6d109092e4e492ab02482f91", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "sed aliqua in aute" } ], "inactive": true, "lastLogin": "1974-08-04T00:10:28.627Z", "_meta": { "created": "1988-10-07T00:11:11.273Z", "updated": "1985-09-17T05:57:44.369Z", "migrationVersion": -72967271 }, "email": "nisi id aute" } } }, { "_id": "2D5d5cDf-546C-E49e-1301-675cdad5E773", "location": "Adapter", "view": "dolor aliqua", "status": "complete", "app": "sit sint sunt aliqua est", "name": "Excepteur fugiat enim sunt sit", "variables": { "decorators": [ { "type": "encryption", "pointer": "/~0/HcoV" } ] }, "last_updated": "1994-07-07T17:38:28.424Z", "encodingVersion": 1, "job": { "_id": "5693ebfdc77e370edf4e3b12", "task": "b4f", "name": "myCoolDocumentName", "description": "Some helpful information about the document", "ancestors": [ "bef823f4562f436074427361" ] }, "incomingRefs": [], "groups": [ { "_id": "c9e9cd6710f528e20b234883", "provenance": "Duis ex mollit", "name": "veniam mollit in voluptate est", "description": "in", "memberOf": [ { "groupId": "6c6919c937c6f45d4bc4929f", "aaaManaged": true }, { "groupId": "0cb591e0e7059e7722c31b9f", "aaaManaged": false }, { "groupId": "1ab6e5ff1eb1266c2e093c01", "aaaManaged": false }, { "groupId": "b596d31a332cadaef47459e8", "aaaManaged": false }, { "groupId": "3ea614c1651db1501666c5c0", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "occaecat Ut est et dolore" }, { "roleId": "Lorem voluptate quis proident" }, { "roleId": "exercitation amet do non esse" } ], "inactive": false, "_meta": { "created": "1947-08-07T18:17:23.738Z", "updated": "1959-06-21T07:27:19.646Z", "migrationVersion": -26461758 } }, "974389971bbe9e52d83156cf", "b172ff61486e7b81a06201b3", { "_id": "0f01895a1885cf2795eb2f12", "provenance": "Lorem", "name": "culpa adipisicing aliquip qui", "description": "dolore reprehenderit culpa", "memberOf": [ { "groupId": "39341cb666bb13800fe7fb13", "aaaManaged": true }, { "groupId": "737170a834fdf507c0f30a49", "aaaManaged": false }, { "groupId": "8c12bc424a7ba86ecb89b5ab", "aaaManaged": true }, { "groupId": "160627b1760901d537aa759f", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "sunt do" }, { "roleId": "officia" }, { "roleId": "culpa" }, { "roleId": "velit cillum aliquip fugiat" } ], "inactive": false, "_meta": { "created": "1967-10-13T03:06:20.261Z", "updated": "1996-03-18T02:08:14.627Z", "migrationVersion": -16275464 } }, { "_id": "0181665b59a9e72798378474", "provenance": "ullamco", "name": "enim ut aute labore", "description": "dolor", "memberOf": [ { "groupId": "53559fa705f399ce73d3b7ca", "aaaManaged": false }, { "groupId": "ed13325d981ab6c866ef46f4", "aaaManaged": true }, { "groupId": "eb779db973336c2c740c44f7", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "ea nulla labore culpa quis" }, { "roleId": "qui sit enim aute elit" }, { "roleId": "irure ex" }, { "roleId": "dolore ad" } ], "inactive": false, "_meta": { "created": "2008-05-03T23:45:06.072Z", "updated": "1975-10-10T14:55:25.983Z", "migrationVersion": 79131377 } } ], "type": "automatic", "metrics": { "start_time": "cillum ipsum nisi", "end_time": -18383133.82835342, "server_id": "ex", "finish_state": "success", "run_time": 136723.99665299058, "retrying": null, "user": "", "owner": "676b3a1bdaf4097366f8e102" } }, { "_id": "dB3f3b29-A2d6-959E-6a98-d4B1117E315F", "location": "Broker", "view": "culpa Ut aute amet", "status": "running", "app": "nisi dolor ad nostrud", "name": "quis", "variables": { "decorators": [ { "type": "encryption", "pointer": "/~1/~1/X-/~0/~0/XGsj+pA7/~1/~1/~0/BrngHL9" }, { "type": "encryption", "pointer": "/~0/~1/~0/~1/~0/~0/~1/pBu-7,u/~1/~0/~0" } ] }, "last_updated": "2003-01-25T07:37:21.046Z", "encodingVersion": 1, "job": { "_id": "bbd1c95ea5e3d31de5a9b5bc", "task": "b4f", "name": "myCoolDocumentName", "description": "Some helpful information about the document", "ancestors": null }, "incomingRefs": [], "groups": [ { "_id": "11dd3cc0b07fe097f355ea1f", "provenance": "ut aliqua dolor consectetur et", "name": "consectetur", "description": "nulla cupidatat aute adipisicing", "memberOf": [ { "groupId": "ee87e90d3748e6cfeda6e6a1", "aaaManaged": true }, { "groupId": "ad15b67a557741aa298ad839", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "quis minim laboris sunt" }, { "roleId": "amet est veniam Ut" } ], "inactive": false, "_meta": { "created": "1966-09-26T20:45:37.671Z", "updated": "2003-06-30T14:40:50.955Z", "migrationVersion": -12961016 } } ], "type": "automatic", "metrics": { "start_time": "anim", "end_time": -35868670.0175249, "server_id": "deserunt sunt nisi ea commodo", "finish_state": "success", "run_time": -11824727.180700645, "retrying": null, "user": "8fd7a88353b17179f5ccd40e", "owner": "86759f0c22014107e9b00355" } } ], "metadata": { "skip": 82197587, "limit": -32556930, "total": 97981317, "nextPageSkip": -17571876, "previousPageSkip": -2732259, "currentPageSize": -24105699 } }
{ "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" } } } ] }