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": "description", "exclude": "description", "in": "dolor laborum", "not-in": "in commodo", "equals": "proident Lorem Excepteur exercitation aliquip", "contains": "nostrud sit", "starts-with": "amet Duis occaecat dolor Ut", "ends-with": "consequat Ut aute", "dereference": "cillum", "gt": "ea", "gte": "dolor incididunt veniam tempor", "lt": "in", "lte": "ea Excepteur ipsum eiusmod elit", "q": "nisi id nulla et minim", "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": "75Ab6CEf-C8b0-087D-Ec3a-295AFfAAeA07", "location": "Broker", "view": "commodo", "status": "failure", "app": "id sint aliquip reprehenderit", "name": "Duis aute est consequat", "variables": { "decorators": [ { "type": "encryption", "pointer": "/DY9/~0/~1/~0/RTpluGnYP,,/~0/l/E/~0/p/rU+" }, { "type": "encryption", "pointer": "/~0/~0/~0/~1/~1/~1" } ] }, "last_updated": "1982-07-27T15:57:43.045Z", "encodingVersion": 1, "job": { "_id": "2ff802f580820fdcd683e742", "task": "e28f", "name": "myCoolDocumentName", "description": "Some helpful information about the document", "ancestors": null }, "groups": [ { "_id": "0f8097e1ad6289a2fe8c91db", "provenance": "sint consectetur", "name": "Ut consectetur et ut", "description": "cillum", "memberOf": [ { "groupId": "b34ab47a99aede62be5dd3bb", "aaaManaged": false }, { "groupId": "2b215c74405f772971eb46f0", "aaaManaged": true }, { "groupId": "fb03b8404108017bc6ae9685", "aaaManaged": true }, { "groupId": "39f4d263d391f9c6229f3b33", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "ullamco anim deserunt" } ], "inactive": false, "_meta": { "created": "2022-12-25T02:59:30.307Z", "updated": "1949-10-02T02:45:41.933Z", "migrationVersion": -87440922 } } ], "type": "manual", "metrics": { "start_time": "ea minim nostrud commodo veniam", "claim_time": "1945-11-16T10:35:00.955Z", "end_time": 16143948.074501276, "server_id": "dolor nulla eiusmod", "finish_state": "success", "run_time": -18971377.36444816, "user": { "_id": "49c916c82095a15635008030", "provenance": "esse occaecat", "username": "tempor velit ullamco fugiat", "firstname": "ut nostrud officia veniam", "memberOf": [ { "groupId": "5ade6b8cfffe21d38214e679", "aaaManaged": true }, { "groupId": "2478a05683bc134c68039d09", "aaaManaged": false }, { "groupId": "95128e6189b7958d2ecb09ab", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "dolor qui laborum" }, { "roleId": "fugiat reprehenderit irure Lorem aliqua" } ], "inactive": false, "lastLogin": "2009-08-17T23:33:49.311Z", "_meta": { "created": "1949-01-29T18:21:25.989Z", "updated": "1974-01-16T00:29:20.965Z", "migrationVersion": 51024022 }, "email": "id" }, "owner": "c733b010a2bd1adf66879132" } }, { "_id": "e1c0dD53-BA5d-28f8-6f0a-01B5c9edfcCc", "location": "Adapter", "view": null, "status": "canceled", "app": "eu qui ut enim", "name": "minim", "variables": { "decorators": [ { "type": "encryption", "pointer": "/~1/Xk0/yxAR/~1/~1/iu9wTOBr2x/~1/Bvfq/~0" }, { "type": "encryption", "pointer": "/jNO+hllcG/I1+BZ+sEQ/~1/w.No46.7Q" } ] }, "last_updated": "1976-07-25T09:22:13.963Z", "encodingVersion": 1, "job": { "_id": "34869988d18df130b8e7d207", "task": "3a1f", "name": "myCoolDocumentName", "description": "Some helpful information about the document", "ancestors": [ "1c734441592ed8bbc439f24e", "f2cc38f9731a642c71a1e376", "88fac8ca917a8b52c341bd32" ] }, "groups": [ { "_id": "f9be932f30644bb146f1129d", "provenance": "nisi exercitation Ut sint mollit", "name": "minim dolor quis", "description": "exercitation", "memberOf": [ { "groupId": "b051eb67b0180e17db93d663", "aaaManaged": true }, { "groupId": "a375dc3bc0277e6ed9cdd633", "aaaManaged": true }, { "groupId": "e9332c6b8282d155e205addf", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "laboris est velit" } ], "inactive": false, "_meta": { "created": "1948-04-09T22:38:18.61Z", "updated": "1964-06-22T21:53:12.331Z", "migrationVersion": -79930230 } } ], "type": "manual", "metrics": { "start_time": "ex labore mollit minim", "claim_time": "2017-02-13T01:10:25.147Z", "end_time": 6716022.418876648, "server_id": "fugiat in cupidatat amet", "finish_state": "success", "run_time": -95003443.75914435, "user": "Pronghorn", "owner": { "_id": "1e00fdefa4282530db673cc6", "provenance": "exercitation adipisicing sit aliqua", "username": "tempor", "firstname": "anim dolor", "memberOf": [ { "groupId": "8d11cb5c588e5956c4abf0aa", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "irure voluptate in" }, { "roleId": "pariatur adipisicing anim consectetur" }, { "roleId": "laboris" } ], "inactive": false, "lastLogin": "1957-05-28T22:01:23.633Z", "_meta": { "created": "2014-10-14T21:54:27.334Z", "updated": "1984-06-23T22:05:52.41Z", "migrationVersion": -25969529 }, "email": "aute" } } }, { "_id": "B0aCfb9d-c93C-c7cb-Fd19-c86DfB6Dd186", "location": "Adapter", "view": "dolor", "status": "incomplete", "app": "ullamco ex aliqua", "name": "dolore", "variables": { "decorators": [ { "type": "encryption", "pointer": "/uv496/Qwhz/VHC,av" }, { "type": "encryption", "pointer": "/l/nK2yG5VG./~0/~1/I1HsOJ7CR+/duP0/~1/ivR/IsehWr6w" }, { "type": "encryption", "pointer": "/~1/k5Bmz/~1/~0/~1/~0/N3i8QCqy/jDE4pyRz/oTNEKwY" }, { "type": "encryption", "pointer": "/~0/~1/Ww9//ALlLW83LFCy/~0" } ] }, "last_updated": "1955-08-01T18:52:37.011Z", "encodingVersion": 1, "job": { "_id": "54e32b6c238939b9496d430d", "task": "e28f", "name": "myCoolDocumentName", "description": "Some helpful information about the document", "ancestors": null }, "groups": [ { "_id": "c21d75afc886f1fb2649cd65", "provenance": "sit sed", "name": "do sunt minim occaecat quis", "description": "aute sit esse aliqua", "memberOf": [ { "groupId": "5b03e6252c7db75ae5bbcdb6", "aaaManaged": false }, { "groupId": "9963ac3a2dba1a3657f9b8fa", "aaaManaged": true }, { "groupId": "62ef04a2c0137cf28c52b785", "aaaManaged": true }, { "groupId": "a98bf510ffbd8722905710e5", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "consequat quis esse deserunt" }, { "roleId": "dolor qui cupidatat in" }, { "roleId": "ipsum quis dolore" }, { "roleId": "in aliqua incididunt dolor" }, { "roleId": "Lorem commodo cillum aliqua laborum" } ], "inactive": true, "_meta": { "created": "2023-08-14T10:53:21.958Z", "updated": "1980-08-29T06:44:09.215Z", "migrationVersion": 95606624 } } ], "type": "manual", "metrics": { "start_time": "id laborum dolor velit", "claim_time": "1966-02-27T13:10:28.797Z", "end_time": -49665569.872860394, "server_id": "magna aliqua", "finish_state": "success", "run_time": -6570314.163390785, "user": "9e5da116711691c07a7a5d6f", "owner": { "_id": "4da15b3a9fc43410221a49bd", "provenance": "occaecat sit sint deserunt", "username": "in exercitation", "firstname": "ex eu Lorem in", "memberOf": [ { "groupId": "eeac2e609f49c936fb56fa64", "aaaManaged": true }, { "groupId": "da8cfa29c3c074c7aaa17575", "aaaManaged": false }, { "groupId": "89275eb1e7cad102dd59cea5", "aaaManaged": false }, { "groupId": "f616a784d72a902ecef5ea86", "aaaManaged": false }, { "groupId": "0f38ec7123d3c0ef6477ffbf", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "in cupidatat occaecat quis aute" } ], "inactive": true, "lastLogin": "1966-02-11T02:45:58.174Z", "_meta": { "created": "2021-05-06T00:04:27.266Z", "updated": "1965-12-12T12:00:36.121Z", "migrationVersion": -36133078 }, "email": "nisi in reprehenderit exercitation officia" } } }, { "_id": "e5BfAB5A-aF6b-642d-2a62-EBF716B6fAe2", "location": "Broker", "view": null, "status": "scheduled", "app": "adipisicing incididunt irure nostrud in", "name": "cillum aliqua et anim aliquip", "variables": { "decorators": [ { "type": "encryption", "pointer": "/~1/~0/~1/~0/A-agJfLuT08/nMIP." }, { "type": "encryption", "pointer": "/qmE/fC/~1/AtZyFk5r" }, { "type": "encryption", "pointer": "/iZ/~0/C/J.mMi2XB/Fc92WcPdIRP/QAEHbQxxh+/CSs.L-/~0" } ] }, "last_updated": "2024-12-29T14:39:04.785Z", "encodingVersion": 1, "job": { "_id": "d231fecbdbf8ea9aef0170e9", "task": "b4f", "name": "myCoolDocumentName", "description": "Some helpful information about the document", "ancestors": [ "c0dbe63ab31a8e0568d8589e", "dcbab3685daae3fde39aa11c", "9c3ae21e21dac96c9f3fc61f", "65f568453394585528afc804" ] }, "groups": [ "37ae35171ce5aa50b23d3acf" ], "type": "manual", "metrics": { "start_time": "ex", "claim_time": "1997-01-19T00:44:21.922Z", "end_time": 50972309.620916486, "server_id": "irure Duis", "finish_state": "success", "run_time": 1953773.4116069824, "user": { "_id": "7882701b36baf464bcf3528e", "provenance": "consequat esse velit", "username": "aute", "firstname": "incididunt deserunt aliqua", "memberOf": [ { "groupId": "2c57e0825e25fbff9589f8d4", "aaaManaged": true }, { "groupId": "c69249b95ab73cb514b8d7ca", "aaaManaged": true }, { "groupId": "26e8c8bedca5f155ac58e8a3", "aaaManaged": true }, { "groupId": "efc06be4f6ca3bfa2d177f34", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "est ea magna sint ut" }, { "roleId": "cillum sunt tempor incididunt" } ], "inactive": true, "lastLogin": "1947-06-02T22:38:26.168Z", "_meta": { "created": "1973-07-04T14:23:44.446Z", "updated": "2010-04-18T14:35:33.949Z", "migrationVersion": 39310936 }, "email": "dolor deserunt ut" }, "owner": "a22ac72693f44e83713b403e" } } ], "metadata": { "skip": -21615769, "limit": -39651240, "total": -19608800, "nextPageSkip": null, "previousPageSkip": null, "currentPageSize": -64643287 } }
{ "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" } } } ] }