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": 10, "skip": 50, "order": 1, "sort": "name", "include": "name", "exclude": "_id,description", "in": "ullamco", "not-in": "quis ea ullamco in minim", "equals": "nostrud sed officia et pariatur", "contains": "aute consectetur ad pariatur ut", "starts-with": "pariatur ex enim ut", "ends-with": "sit fugiat mollit ad", "dereference": "aliqua", "gt": "elit eu ad fugiat consequat", "gte": "in veniam proident", "lt": "in ut aute non", "lte": "quis non consequat magna", "q": "cupidatat ullamco officia voluptate", "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": "082CDA7F-E2F7-a515-Cdae-dbfc6bDaDE8a", "location": "Application", "view": null, "status": "failure", "app": "ut irure sed", "name": "nulla", "variables": { "decorators": [ { "type": "encryption", "pointer": "/~0/~0" }, { "type": "encryption", "pointer": "/~1/re/uedI0BJ+/V3qxYzjqe/IJ2SQjtc,z/BhDK5/~1" } ] }, "last_updated": "1958-07-22T18:46:41.553Z", "encodingVersion": 1, "job": { "_id": "ac4649e61048b0f56db0c5d7", "task": "3a1f", "name": "myCoolDocumentName", "description": "Some helpful information about the document", "ancestors": null }, "incomingRefs": [], "groups": [ { "_id": "04cc96f7fa5b59a16a09f7a6", "provenance": "commodo do id", "name": "id est nisi", "description": "est laborum", "memberOf": [ { "groupId": "0a7de3abcb352fd991f65676", "aaaManaged": false }, { "groupId": "3c84cb1e50460daa4d884138", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "aliquip officia in quis" }, { "roleId": "Lorem" } ], "inactive": false, "_meta": { "created": "2021-08-07T06:51:46.218Z", "updated": "1996-05-30T02:15:19.164Z", "migrationVersion": -97424345 } } ], "type": "automatic", "metrics": { "start_time": "dolor dolore magna in", "end_time": 80906082.21166375, "server_id": "adipisicing cupidatat incididunt", "finish_state": "success", "run_time": -57079016.381048664, "retrying": false, "user": "", "owner": "Pronghorn" } }, { "_id": "FeEB2342-Adcc-Eec0-bbdF-32cCe2EefFE0", "location": "Application", "view": "eiusmod cupidatat esse ex in", "status": "failure", "app": "adipisicing eu sit nostrud aute", "name": "dolore", "variables": { "decorators": [ { "type": "encryption", "pointer": "/~0/~1/ZnV7/l/~0/jjNmpH5+S/lTgtLA2w/N" }, { "type": "encryption", "pointer": "/~1/Z3R6zTK3/~0/G,1/Xmz/J4opKg./TGu+p7/JMB" }, { "type": "encryption", "pointer": "/~1/~0/~0/~1/MlbryEGvHJS/WdNSI.7" }, { "type": "encryption", "pointer": "/q/~0/BE5qHfVYWE/~0/JhqUS/nhC/~1" } ] }, "last_updated": "1959-01-21T17:29:25.277Z", "encodingVersion": 1, "job": { "_id": "f6df14b833a64108a2276674", "task": "b4f", "name": "myCoolDocumentName", "description": "Some helpful information about the document", "ancestors": null }, "incomingRefs": [], "groups": [ { "_id": "841233773d410a8cae374716", "provenance": "dolor minim aliquip ad", "name": "magna", "description": "Lorem et non Ut", "memberOf": [ { "groupId": "efa8fb11c1a833dd8ea74c79", "aaaManaged": true }, { "groupId": "3a48a10474d5b434f550fca8", "aaaManaged": true }, { "groupId": "7390397cadfcd361a83c9cf0", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "nisi pariatur elit" } ], "inactive": true, "_meta": { "created": "1975-11-02T12:01:43.584Z", "updated": "2015-03-29T21:10:39.982Z", "migrationVersion": 69360074 } } ], "type": "automatic", "metrics": { "start_time": "enim occaecat proident", "end_time": 6496294.2200112045, "server_id": "dolor", "finish_state": "complete", "run_time": -42872131.21464095, "retrying": true, "user": "5754855aac972d210c783019", "owner": { "_id": "f81b8ac207789807199f0782", "provenance": "consectetur cillum", "username": "irure", "firstname": "sunt elit", "memberOf": [ { "groupId": "f2e5d04d6a761671f063df03", "aaaManaged": false }, { "groupId": "c9f74cc0861779221761c14d", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "ut commodo cupidatat Duis" }, { "roleId": "mollit" }, { "roleId": "Excepteur ut nulla velit fugiat" } ], "inactive": true, "lastLogin": "2019-09-25T13:41:40.123Z", "_meta": { "created": "1998-08-09T09:17:13.266Z", "updated": "2006-08-22T01:04:12.757Z", "migrationVersion": -39172884 }, "email": "ex esse voluptate sit" } } }, { "_id": "0af49E7b-1dB6-d3a7-7fA0-97F4fcb2108a", "location": "Application", "view": "veniam nostrud est", "status": "scheduled", "app": "elit aute pariatur incididunt", "name": "consequat", "variables": { "decorators": [ { "type": "encryption", "pointer": "/KMBMqy78/~0/y/Bp1/~1/~1/sHSF+Pg7em/fjH2vb2xy/~0/~0/~0" }, { "type": "encryption", "pointer": "/we-SYmt9F1" } ] }, "last_updated": "1982-02-26T22:42:48.386Z", "encodingVersion": 1, "job": { "_id": "219c9370da8dbb8d911acf26", "task": "e28f", "name": "myCoolDocumentName", "description": "Some helpful information about the document", "ancestors": null }, "incomingRefs": [], "groups": [ "baa01dfde6d12f95d9a24ca9", "dbeb98d35be94a5575339590", { "_id": "ba46b91e6b10071b0f54b629", "provenance": "occaecat reprehenderit", "name": "ut deserunt proident fugiat eiusmod", "description": "id", "memberOf": [ { "groupId": "8b713f96600d8695de7c3ed8", "aaaManaged": true }, { "groupId": "de53397fa15d9e97aed58378", "aaaManaged": true }, { "groupId": "44a6130581ccd29ebfe28780", "aaaManaged": false }, { "groupId": "4c66341fab1c0354b3f8ecf9", "aaaManaged": true }, { "groupId": "56864b7edb1e823662e6072e", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "nisi dolore" }, { "roleId": "mollit aliqua dolor laboris proident" } ], "inactive": false, "_meta": { "created": "1970-05-13T21:25:27.294Z", "updated": "1966-08-14T06:57:30.671Z", "migrationVersion": 9623397 } }, { "_id": "5e8dd27464d5c05dd0ebaaf3", "provenance": "Duis ut aliqua ullamco minim", "name": "ut aliquip occaecat in", "description": "ut velit est exercitation", "memberOf": [ { "groupId": "c3dc675dfd251a4a243d3cd1", "aaaManaged": false }, { "groupId": "33a0fc5d1327769465d559d8", "aaaManaged": false }, { "groupId": "b30099991c2378155e3b94b2", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "dolor" }, { "roleId": "ad Duis enim elit aute" }, { "roleId": "ex" }, { "roleId": "adipisicing deserunt amet" } ], "inactive": false, "_meta": { "created": "1978-09-19T12:59:02.914Z", "updated": "1983-11-30T22:18:18.587Z", "migrationVersion": 62944511 } }, "34efe51992f20df9443bef17" ], "type": "automatic", "metrics": { "start_time": "in Ut proident", "end_time": 99184102.24372584, "server_id": "qui anim quis aliquip Ut", "finish_state": "error", "run_time": -21572737.398803413, "retrying": false, "user": "", "owner": "69c3d8c990646607771c1e82" } }, { "_id": "06cCbD0c-e652-CAF0-C8E4-bDDC3D2c30cb", "location": "Application", "view": "in ea ipsum ut sint", "status": "failure", "app": "qui adipisicing enim sint", "name": "nostrud sunt cupidatat ut do", "variables": { "decorators": [ { "type": "encryption", "pointer": "/x/~0/~0/~1/N90zQg-t" }, { "type": "encryption", "pointer": "/TunEp/~0/h-hiHoSu/OYS/uV/~1/c8T2lri/e" }, { "type": "encryption", "pointer": "/qzDjK/h7Mel/OR" } ] }, "last_updated": "2015-09-16T15:46:16.604Z", "encodingVersion": 1, "job": { "_id": "422da7b9bbd0a28a57b89e09", "task": "3a1f", "name": "myCoolDocumentName", "description": "Some helpful information about the document", "ancestors": [ "874076cfe463269f4fda043e", "9adebe3caa163a6a72752de5", "2e445c6edd33b3baaa7a4113", "6c164b8dd25076011b7ff45c", "1cf221b9665a10bb3d55e7b4" ] }, "incomingRefs": [], "groups": [ "f0da369fc5d83b6f388ab95f", "4e52e1c89f6d77c851319d3f", { "_id": "685537f728fcc7e8d433fbc2", "provenance": "consectetur incididunt non adipisicing", "name": "occaecat consequat in id", "description": "eu in dolor", "memberOf": [ { "groupId": "8ff52daac2cdac59996ecb59", "aaaManaged": true }, { "groupId": "d60bfec9b326ca1256feb73a", "aaaManaged": true }, { "groupId": "b6aeefbb2e190f4778db4cec", "aaaManaged": false }, { "groupId": "d9abb12786e37233a53288f4", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "occaecat est consectetur adipisicing id" }, { "roleId": "Ut" }, { "roleId": "esse occaecat do" } ], "inactive": false, "_meta": { "created": "1976-07-12T01:14:30.042Z", "updated": "1958-07-11T08:59:47.343Z", "migrationVersion": 24143658 } }, "a741b8ba4f06ba24bc9c518e" ], "type": "automatic", "metrics": { "start_time": "ea", "end_time": -88135367.32668865, "server_id": "aliqua reprehenderit labore", "finish_state": "success", "run_time": -57340211.98735859, "retrying": null, "user": { "_id": "b7c101f60b22a39f8a106ad6", "provenance": "esse et deserunt", "username": "exercitation eiusmod eu pariatur amet", "firstname": "elit cillum occaecat sint dolor", "memberOf": [ { "groupId": "e60a1a12af6cd358ce01f930", "aaaManaged": false }, { "groupId": "743bbce8314875b5a98d2086", "aaaManaged": true }, { "groupId": "b4ae9795fec057a916d14145", "aaaManaged": true }, { "groupId": "de66b65a400f4326400aadad", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "ut" }, { "roleId": "quis ipsum consectetur reprehenderit irure" } ], "inactive": true, "lastLogin": "1947-11-11T23:13:07.257Z", "_meta": { "created": "2005-02-09T19:40:09.978Z", "updated": "2016-12-19T08:06:41.722Z", "migrationVersion": 92692092 }, "email": "Ut" }, "owner": { "_id": "64b2a2a0c9be632648008c91", "provenance": "sunt ullamco", "username": "magna ullamco", "firstname": "exercitation dolor qui Ut", "memberOf": [ { "groupId": "3a944d187bcaecb264e72801", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "labore esse et" }, { "roleId": "ea minim cillum Excepteur irure" }, { "roleId": "mollit deserunt" } ], "inactive": true, "lastLogin": "1981-07-27T22:51:43.14Z", "_meta": { "created": "1954-04-26T21:55:34.366Z", "updated": "2024-08-15T19:46:41.488Z", "migrationVersion": 39508091 }, "email": "fugiat" } } } ], "metadata": { "skip": -46485826, "limit": -37736756, "total": -16416726, "nextPageSkip": 30375067, "previousPageSkip": -75381992, "currentPageSize": 70872155 } }
{ "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" } } } ] }