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": 1, "skip": 0, "order": 1, "sort": "name", "include": "name", "exclude": "_id,description", "in": "occaecat laboris qui deserunt ea", "not-in": "laboris sunt pariatur ex commodo", "equals": "do deserunt sint in exercitation", "contains": "sit", "starts-with": "nostrud quis fugiat", "ends-with": "culpa", "dereference": "consequat dolor in est non", "gt": "consectetur", "gte": "mollit fugiat eiusmod non ullamco", "lt": "do labore qui", "lte": "deserunt non", "q": "elit mollit", "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": "44Ca32C7-a693-0ACB-cCBf-0b3BD1D9EbA3", "location": "Broker", "view": "in sed commodo occaecat", "status": "scheduled", "app": "et aute commodo irure", "name": "in reprehenderit", "variables": { "decorators": [ { "type": "encryption", "pointer": "/Sj/~1/AFS/qYpqK3qnK/~1/kc/~0/I/k" }, { "type": "encryption", "pointer": "/~0/u/e0byt4/ls/~1" }, { "type": "encryption", "pointer": "/~0/Rw.PFtjn/~0/~0" }, { "type": "encryption", "pointer": "/y/aY" } ] }, "last_updated": "1984-08-28T06:48:25.061Z", "encodingVersion": 1, "job": { "_id": "ece1ff08985446ace3dc0bcd", "task": "b4f", "name": "myCoolDocumentName", "description": "Some helpful information about the document", "ancestors": [ "3bf7acc202c8acf272585896", "a936c0bdadcee089002c5795", "81ed71ead716220e6fffcfc8", "50b59b06391e84b4f8e96b3d" ] }, "groups": [ "e9c6592615f4ed8484d8a687", "43c4e56d8ed696960d0c3aef", { "_id": "fdc97631e5aabf0d1babb02a", "provenance": "exercitation in ullamco elit ea", "name": "sint", "description": "Lorem", "memberOf": [ { "groupId": "57b6470d8286ad3e7445ed65", "aaaManaged": false }, { "groupId": "84c5a6ce537cfb1cfff7cc7f", "aaaManaged": true }, { "groupId": "c1833abb6f06c441672bfba3", "aaaManaged": false }, { "groupId": "799549162ee2858114791b7f", "aaaManaged": false }, { "groupId": "e565d810ad4c65f123ec0b25", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "irure laboris sunt" }, { "roleId": "aliquip labore enim" }, { "roleId": "nulla" }, { "roleId": "voluptate exercitation culpa Excepteur dolor" }, { "roleId": "cupidatat" } ], "inactive": true, "_meta": { "created": "1947-11-01T07:19:23.581Z", "updated": "1964-07-18T23:34:33.711Z", "migrationVersion": -60730348 } } ], "type": "operation", "metrics": { "start_time": "reprehenderit", "end_time": -77622910.01207756, "server_id": "nostrud ea non minim eiusmod", "finish_state": "running", "run_time": 18000701.278675675, "retrying": true, "user": { "_id": "fcbdc3950a9aba984d8ae1e1", "provenance": "nulla culpa Lorem", "username": "ut laboris", "firstname": "dolore proident sit exercitation", "memberOf": [ { "groupId": "4f6b8acd2e282b46bd0e6b5c", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "laboris commodo" }, { "roleId": "culpa ipsum laborum nulla aliquip" }, { "roleId": "ut anim cillum laboris" }, { "roleId": "sint occaecat officia ullamco" }, { "roleId": "minim ipsum id in reprehenderit" } ], "inactive": true, "lastLogin": "1974-02-21T14:42:39.28Z", "_meta": { "created": "1965-06-05T15:50:23.919Z", "updated": "2016-05-27T17:32:37.062Z", "migrationVersion": 81488432 }, "email": "irure aute" }, "owner": { "_id": "74ccad5833b2b53cac81cd20", "provenance": "culpa", "username": "sit et magna", "firstname": "ut exercitation", "memberOf": [ { "groupId": "f363e8cd5784a6afb8fcbbe6", "aaaManaged": true }, { "groupId": "54a9b77166800108b12b9eb1", "aaaManaged": false }, { "groupId": "7767391fb181b251f5055a85", "aaaManaged": true }, { "groupId": "8573740519d7cc16d6a155f3", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "Excepteur amet nostrud dolor labore" }, { "roleId": "aute do sed nostrud Excepteur" }, { "roleId": "qui officia" }, { "roleId": "ut" }, { "roleId": "mollit pariatur laboris" } ], "inactive": false, "lastLogin": "1953-01-09T14:56:46.898Z", "_meta": { "created": "1973-05-12T22:35:53.16Z", "updated": "1995-10-14T01:20:27.653Z", "migrationVersion": 22671958 }, "email": "veniam amet nulla qui eiusmod" } } }, { "_id": "9452A5a6-D7b8-A7f1-ec66-e55ABd7f4c42", "location": "Adapter", "view": "tempor", "status": "scheduled", "app": "Duis eu in", "name": "elit proident", "variables": { "decorators": [ { "type": "encryption", "pointer": "/~0/Lydz/J5aWT.VZ8/in5OYV4bg/~1" }, { "type": "encryption", "pointer": "/Qq45g/HyMiPfbF2/W9re8" }, { "type": "encryption", "pointer": "/~0/~0/~1/W9cs-3/zYaK7Grqj4/qL" }, { "type": "encryption", "pointer": "/SZH+" }, { "type": "encryption", "pointer": "/~0/xqIREGZ" } ] }, "last_updated": "2003-07-26T18:54:46.76Z", "encodingVersion": 1, "job": { "_id": "64eb4be258cfcafadb5dd34a", "task": "3a1f", "name": "myCoolDocumentName", "description": "Some helpful information about the document", "ancestors": null }, "groups": [ "ca11680e6db78a4b5cd61ba4", { "_id": "b10e17c34feb4e1c32152b63", "provenance": "ex labore reprehenderit irure", "name": "minim aute et", "description": "sed officia", "memberOf": [ { "groupId": "d6a699b791877f71fc67e47a", "aaaManaged": true }, { "groupId": "0ad1583368bee911bfaf819f", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "consectetur quis" } ], "inactive": true, "_meta": { "created": "1959-01-22T02:43:59.814Z", "updated": "1944-08-03T11:08:05.937Z", "migrationVersion": 21793758 } }, "8e9787156d177ec4d0180b8c", "6e2b84335e2cfb8d91578da4", { "_id": "34551ea73104b3db90e3ad62", "provenance": "labore", "name": "exercitation ipsum ad nisi nulla", "description": "aliquip", "memberOf": [ { "groupId": "02ba30f222c9440a2b99b3c4", "aaaManaged": false }, { "groupId": "0014a3f4f93822cf21a7c685", "aaaManaged": false }, { "groupId": "89ff0fe30f22bedbdf2221d8", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "ut et fugiat incididunt Excepteur" }, { "roleId": "do voluptate consequat commodo ea" }, { "roleId": "mollit" }, { "roleId": "cupidatat in aliquip enim" }, { "roleId": "irure exercitation" } ], "inactive": true, "_meta": { "created": "2017-08-11T06:24:35.324Z", "updated": "2022-07-20T02:13:57.571Z", "migrationVersion": 19014202 } } ], "type": "operation", "metrics": { "start_time": "non ea laboris Excepteur", "end_time": 42154976.75337216, "server_id": "id", "finish_state": "success", "run_time": -77016138.82936953, "retrying": false, "user": { "_id": "8a190102ce0842ed7ca38f14", "provenance": "amet", "username": "commodo in dolore", "firstname": "esse deserunt nostrud aute", "memberOf": [ { "groupId": "cb440132464807f89e54dc32", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "esse quis do sed ipsum" }, { "roleId": "ut dolor aliquip" } ], "inactive": false, "lastLogin": "2023-11-14T08:31:39.876Z", "_meta": { "created": "2005-09-09T06:38:28.551Z", "updated": "2004-11-18T11:35:13.98Z", "migrationVersion": 82183324 }, "email": "aliqua sed Excepteur dolore" }, "owner": "69a6bbe653c38719acf490a4" } }, { "_id": "EA79368F-829E-0980-821C-54b70B119907", "location": "Application", "view": "proident", "status": "scheduled", "app": "eiusmod non tempor officia", "name": "occaecat", "variables": { "decorators": [ { "type": "encryption", "pointer": "/~0/~1/~1/yHVovp6zK/Pvq7/ia/aKxR3" }, { "type": "encryption", "pointer": "/~0/~1/~0/~0/P," } ] }, "last_updated": "1999-10-23T02:26:13.716Z", "encodingVersion": 1, "job": { "_id": "d21bc237c6212d63d855fea2", "task": "e28f", "name": "myCoolDocumentName", "description": "Some helpful information about the document", "ancestors": null }, "groups": [ "591645aea1519a1695d20a93", "f579a739b46da53feb4690da", { "_id": "03d6cca1cbe99c92904579f5", "provenance": "sunt Lorem", "name": "dolore ex nisi occaecat commodo", "description": "dolor ullamco labore esse culpa", "memberOf": [ { "groupId": "b6a85aa0b4319220a88516b0", "aaaManaged": true }, { "groupId": "98411722abbf9fbd8784586f", "aaaManaged": false }, { "groupId": "a6a2afb85d63fd769d879ca5", "aaaManaged": true }, { "groupId": "95aad6e519700ef5eae59a3a", "aaaManaged": false }, { "groupId": "20c2f0b272bd2f3ef322e700", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "proident labore nisi ipsum anim" }, { "roleId": "ullamco" }, { "roleId": "in" }, { "roleId": "non do cupidatat" } ], "inactive": true, "_meta": { "created": "1961-08-11T06:55:00.49Z", "updated": "1979-09-19T15:54:00.708Z", "migrationVersion": 5211192 } }, { "_id": "7bc92e1764cec4ffbca5ebd3", "provenance": "consequat", "name": "in et ut aute", "description": "aliquip adipisicing", "memberOf": [ { "groupId": "41f00a35cdd5d48039f48e8d", "aaaManaged": true }, { "groupId": "5e15154a9824c735e59e08e2", "aaaManaged": true }, { "groupId": "3246c49517191360831c98d6", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "culpa nostrud exercitation tempor sunt" }, { "roleId": "ut aliquip irure" }, { "roleId": "mollit" } ], "inactive": true, "_meta": { "created": "1994-11-03T20:31:45.395Z", "updated": "2006-05-03T09:02:53.247Z", "migrationVersion": 34320275 } }, { "_id": "2c0be24e15f42ea33ca1b257", "provenance": "ad", "name": "ea aliquip in", "description": "aute velit culpa Ut elit", "memberOf": [ { "groupId": "6e9081cc56d31af7cb046666", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "dolore" }, { "roleId": "in non ad" }, { "roleId": "et sed" }, { "roleId": "Excepteur cillum" }, { "roleId": "in est cupidatat" } ], "inactive": true, "_meta": { "created": "1956-08-20T06:42:28.519Z", "updated": "1971-01-03T22:27:28.864Z", "migrationVersion": 27482061 } } ], "type": "operation", "metrics": { "start_time": "nisi nostrud fugiat cupidatat occaecat", "end_time": -76630495.59842947, "server_id": "Duis adipisicing", "finish_state": "running", "run_time": -81919401.26054358, "retrying": false, "user": { "_id": "9f9c4c1619648fcb1699db22", "provenance": "dolor magna ad", "username": "culpa dolore", "firstname": "eiusmod deserunt aute", "memberOf": [ { "groupId": "f743f061a79608e673d5edfa", "aaaManaged": true }, { "groupId": "e310a96cc9610639572d03f7", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "nulla" }, { "roleId": "enim Excepteur exercitation" } ], "inactive": false, "lastLogin": "2012-02-22T09:30:36.2Z", "_meta": { "created": "1997-07-21T01:04:02.698Z", "updated": "2009-06-06T20:35:29.175Z", "migrationVersion": 53186684 }, "email": "nisi ex exercitation culpa ea" }, "owner": "35613ee9e973e9e86e97ca01" } }, { "_id": "BF95b739-adFe-F5b3-e6De-e680D2A3F0d9", "location": "Broker", "view": "labore laborum", "status": "paused", "app": "tempor", "name": "veniam anim cillum", "variables": { "decorators": [ { "type": "encryption", "pointer": "/bW/G/Iw0moZe-" }, { "type": "encryption", "pointer": "/sw5kd.TrU.L/v+," }, { "type": "encryption", "pointer": "/H9QApxWC0N/~0/YhXU/fmy5Lnznz/Tc1.tVR+zW/gFwKoa60/KK-GuPI/~1/~1/~0/ybPvh2.YcgF" }, { "type": "encryption", "pointer": "/~0/~0/~0/~0/w,v6YoQEg/cj.ejRpAXZ/PY49T1taG9/~0/xq/SsLO66" }, { "type": "encryption", "pointer": "/s,cx/TA2UJVCWu" } ] }, "last_updated": "2020-08-11T21:25:15.472Z", "encodingVersion": 1, "job": { "_id": "be98177a95914d28ec69cc0b", "task": "b4f", "name": "myCoolDocumentName", "description": "Some helpful information about the document", "ancestors": null }, "groups": [ "6b0b5ba7bd83a8a14a450d6b", { "_id": "a60f2b4414c9cc086c44490b", "provenance": "dolore", "name": "exercitation Excepteur et sit", "description": "ut dolor nostrud elit eu", "memberOf": [ { "groupId": "800ab6012cb7592208b9e5c5", "aaaManaged": false }, { "groupId": "b199fd52d94e698bc15ae6d0", "aaaManaged": false }, { "groupId": "7e63d66abe8effaf01eebcc5", "aaaManaged": true }, { "groupId": "0c2838a8d9f1d246042a4516", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "nostrud" } ], "inactive": false, "_meta": { "created": "2019-06-26T22:47:42.062Z", "updated": "1996-02-08T00:58:51.859Z", "migrationVersion": 31442645 } } ], "type": "operation", "metrics": { "start_time": "culpa irure laboris aute minim", "end_time": -61376424.24597476, "server_id": "in veniam consequat officia", "finish_state": "scheduled", "run_time": 63584336.33389437, "retrying": null, "user": "62e6c849d7497e6e4930802f", "owner": "Pronghorn" } } ], "metadata": { "skip": 89108949, "limit": -3551271, "total": -15865555, "nextPageSkip": null, "previousPageSkip": 47312185, "currentPageSize": 35861949 } }
{ "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" } } } ] }