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": 1, "order": 1, "sort": "name", "include": "description", "exclude": "description", "in": "non", "not-in": "laboris", "equals": "fugiat dolor", "contains": "est sed incididunt", "starts-with": "ut consequat irure esse", "ends-with": "est elit ex", "dereference": "ut", "gt": "officia cupidatat veniam eu dolor", "gte": "minim magna dolore do sint", "lt": "quis voluptate adipisicing Duis exercitation", "lte": "tempor", "q": "magna officia aute", "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": "B4544bC3-e6d4-AbB0-F2c6-59a5aAF6bD3B", "location": "Broker", "view": null, "status": "running", "app": "ullamco ut nisi commodo", "name": "reprehenderit in nostrud", "variables": { "decorators": [ { "type": "encryption", "pointer": "/~0/~1/~0/~1/naod3tBnel/F8" } ] }, "last_updated": "2011-02-20T04:13:25.961Z", "encodingVersion": 1, "job": { "_id": "a9db23cb6a4452dd0c52bff4", "task": "e28f", "name": "myCoolDocumentName", "description": "Some helpful information about the document", "ancestors": [ "82205dd76942c38c6cb2baaa", "89a54729537c67c74da26fdb", "db1db93e36f3218707a5a877", "afa5abadb4df4e4d7d753b06" ] }, "groups": [ { "_id": "4c99acbb55abba48e45fa4f1", "provenance": "non mollit culpa", "name": "non aute quis", "description": "veniam Ut minim officia", "memberOf": [ { "groupId": "6f82e9419c706b2cda8c166e", "aaaManaged": false }, { "groupId": "9e91f83e6ff15aaee33e137e", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "et minim sed voluptate" }, { "roleId": "irure" }, { "roleId": "dolore" }, { "roleId": "cillum eiusmod sit" } ], "inactive": false, "_meta": { "created": "1950-10-23T08:29:05.666Z", "updated": "1947-11-13T23:35:23.46Z", "migrationVersion": -92357803 } }, { "_id": "dd0bf58d156674552baa5efe", "provenance": "dolore", "name": "occaecat nostrud quis dolor dolore", "description": "ut", "memberOf": [ { "groupId": "e56d1d36726053e041f52dbf", "aaaManaged": true }, { "groupId": "75d7ee6a868d637edc687ca0", "aaaManaged": false }, { "groupId": "1d4f6b2172df62fceab4326a", "aaaManaged": false }, { "groupId": "b3b800e67fe831c4a65e7487", "aaaManaged": false }, { "groupId": "c1e7488ca84be02fd023459e", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "dolore ut" }, { "roleId": "adipisicing sint dolore dolore" }, { "roleId": "id et minim dolor" }, { "roleId": "ipsum dolore amet" } ], "inactive": true, "_meta": { "created": "1980-02-22T20:05:41.601Z", "updated": "1994-04-18T08:05:28.22Z", "migrationVersion": -98413154 } } ], "type": "manual", "metrics": { "start_time": "magna", "claim_time": "1958-06-07T18:50:29.912Z", "end_time": 29893914.307655662, "server_id": "ut reprehenderit Lorem dolore dolore", "finish_state": "success", "run_time": 85972287.03169796, "user": { "_id": "e9c848f94a7a66abde49df95", "provenance": "laboris", "username": "pariatur nulla", "firstname": "ut ullamco magna", "memberOf": [ { "groupId": "c27192459bd1dc701c9cb354", "aaaManaged": false }, { "groupId": "ffa0d8a9f96d75019e2ef81e", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "consectetur esse dolor in irure" }, { "roleId": "aliqua dolor consectetur" } ], "inactive": false, "lastLogin": "1967-12-18T05:03:32.174Z", "_meta": { "created": "2015-04-27T20:01:01.427Z", "updated": "1950-03-29T20:51:06.018Z", "migrationVersion": 37421105 }, "email": "anim sit Lorem magna" }, "owner": "" } }, { "_id": "E67Fa2fc-99D0-D109-deC5-FA56Ed41cbC9", "location": "Adapter", "view": null, "status": "canceled", "app": "non ea sit deserunt", "name": "Lorem veniam id labore", "variables": { "decorators": [ { "type": "encryption", "pointer": "/~1/wsUF6/DjR0/norfnlM71bh/j930W/~0/o-6XJhwDGi/~1/kqGemr/U3-1RAyWk9h/~0" }, { "type": "encryption", "pointer": "/~0/fH/O/ZZus5/~0/~0/GNwtdxrD" }, { "type": "encryption", "pointer": "/q9T0/~1/~1/~1/uTff73Z" }, { "type": "encryption", "pointer": "/YCQf6R/~0/wqW-/hXV//bL,AytOl3/~1/LQVyB/gbniQOUlJM/UxH/q60QYkM7jho/B" }, { "type": "encryption", "pointer": "/~1" } ] }, "last_updated": "2002-11-19T23:17:40.978Z", "encodingVersion": 1, "job": { "_id": "6124524519cd1e08620dab89", "task": "b4f", "name": "myCoolDocumentName", "description": "Some helpful information about the document", "ancestors": null }, "groups": [ { "_id": "7993207d07863f1447454ee6", "provenance": "consequat", "name": "cupidatat ea", "description": "in et", "memberOf": [ { "groupId": "0394dc01d9798a97b02f8a07", "aaaManaged": true }, { "groupId": "b6d329588b3806d9d3d2f694", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "ut ut proident nostrud" } ], "inactive": true, "_meta": { "created": "1979-01-11T22:49:56.786Z", "updated": "1966-10-13T13:29:52.13Z", "migrationVersion": 24433196 } }, "e72ab72a1a7f172eb35a155c", "1cdd1e6a502f886302d63341", { "_id": "9b1c7e36843a004030445ccb", "provenance": "fugiat labore", "name": "eu in Excepteur consequat aliquip", "description": "aliquip ex", "memberOf": [ { "groupId": "f1497ee666ac25b2fe5b7d98", "aaaManaged": false }, { "groupId": "e697605c0423954c9dde2613", "aaaManaged": false }, { "groupId": "009fd39e73059845b37ab91c", "aaaManaged": true }, { "groupId": "0fd4a9c53c02adfc2c442994", "aaaManaged": true }, { "groupId": "d6894316b50fb5398b8b740b", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "ex sint nostrud" }, { "roleId": "irure Duis" }, { "roleId": "laboris aute id" }, { "roleId": "consequat dolor" }, { "roleId": "ex sed" } ], "inactive": false, "_meta": { "created": "1977-10-24T13:27:19.991Z", "updated": "1948-05-15T02:34:47.524Z", "migrationVersion": -60064982 } }, { "_id": "5c4bc62b687e83e423fc4a12", "provenance": "irure et sunt aliquip nostrud", "name": "elit aute ad esse", "description": "dolor exercitation esse", "memberOf": [ { "groupId": "2cc99c2e1b0a3a9fa72e78c3", "aaaManaged": true }, { "groupId": "4a4bc4bbd95cb3ca4e14d2a6", "aaaManaged": true }, { "groupId": "e49da0312f8ea50b69704232", "aaaManaged": true }, { "groupId": "d8d9880caae87e96fbd7880a", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "cupidatat nulla Excepteur tempor qui" } ], "inactive": false, "_meta": { "created": "1999-06-25T11:18:12.068Z", "updated": "1996-04-16T14:15:37.191Z", "migrationVersion": 38623437 } } ], "type": "manual", "metrics": { "start_time": "exercitation", "claim_time": "1975-11-02T21:41:58.511Z", "end_time": -82074713.68629378, "server_id": "ut mollit do", "finish_state": "scheduled", "run_time": -36924820.23832322, "user": "96cb1692ab4842f41951eedd", "owner": "Pronghorn" } }, { "_id": "B42AE43C-0C5d-6b56-b1Ab-15fdDcEe7cb6", "location": "Application", "view": null, "status": "canceled", "app": "culpa", "name": "in ea", "variables": { "decorators": [ { "type": "encryption", "pointer": "/R,jnUHJQMVr/KT/~0/ICSPUpkcr/~1" } ] }, "last_updated": "2008-04-23T06:26:21.433Z", "encodingVersion": 1, "job": { "_id": "67f2e743a030d9ad6f58acf9", "task": "3a1f", "name": "myCoolDocumentName", "description": "Some helpful information about the document", "ancestors": [ "0816b32cb69326c22a0b29ba", "0190a06fcf7248116daea4e6", "67050dacc78f073238ec0134", "ee97e5c43717050018eb2c90" ] }, "groups": [ { "_id": "e78c04fd294ed7688ad47506", "provenance": "aute ut pariatur et", "name": "veniam deserunt in labore magna", "description": "amet ut Lorem sed aliqua", "memberOf": [ { "groupId": "4eda110976e525b2644832f7", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "non sunt quis do ut" }, { "roleId": "enim ut eu ex" }, { "roleId": "Ut officia" }, { "roleId": "non eiusmod minim Excepteur" }, { "roleId": "enim sint tempor officia" } ], "inactive": false, "_meta": { "created": "2000-08-01T13:23:30.986Z", "updated": "1951-10-16T16:57:42.036Z", "migrationVersion": 48487500 } } ], "type": "manual", "metrics": { "start_time": "sunt", "claim_time": "1950-02-19T09:06:12.584Z", "end_time": -59989216.96832182, "server_id": "occaecat", "finish_state": "success", "run_time": 54627609.359693974, "user": "Pronghorn", "owner": { "_id": "919a73a84158f7509c094bdf", "provenance": "commodo consectetur officia", "username": "sit consequat nisi dolor voluptate", "firstname": "est", "memberOf": [ { "groupId": "707b2f59bb0724b0faa11c33", "aaaManaged": true }, { "groupId": "bb46157e7a5bb700282d9aa3", "aaaManaged": false }, { "groupId": "138037a593b10a0110e68bfd", "aaaManaged": false }, { "groupId": "f9e94960e68c6c5299ab1911", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "aliquip proident" }, { "roleId": "Ut pariatur laborum eiusmod proident" }, { "roleId": "eu consequat aliqua" }, { "roleId": "consequat ut dolore" } ], "inactive": false, "lastLogin": "1976-10-14T22:58:06.466Z", "_meta": { "created": "1949-02-05T23:28:01.122Z", "updated": "2018-04-10T01:35:59.295Z", "migrationVersion": 65457212 }, "email": "Ut ea deserunt dolor Duis" } } } ], "metadata": { "skip": 63740995, "limit": 67111114, "total": 49272889, "nextPageSkip": -64527223, "previousPageSkip": 87440478, "currentPageSize": -6828099 } }
{ "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" } } } ] }