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": 1, "order": 1, "sort": "name", "include": "name,description", "exclude": "_id", "in": "ut sunt", "not-in": "dolore laborum Ut", "equals": "ut ut culpa proident", "contains": "sint cillum est dolore nostrud", "starts-with": "deserunt mollit", "ends-with": "voluptate in dolor mollit magna", "dereference": "est sit", "gt": "sunt cillum", "gte": "dolor", "lt": "quis ullamco occaecat do mollit", "lte": "nulla", "q": "occaecat nisi labore dolor anim", "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": "1de0fFFA-2cFA-dF8c-9beF-0eCa61D46EC8", "location": "Application", "view": null, "status": "paused", "app": "nostrud cillum", "name": "Duis incididunt culpa", "variables": { "decorators": [ { "type": "encryption", "pointer": "/~0/~0/uyHQA/~1/~1/~0/QvuF6CcRwmQ/~0/~0/h" } ] }, "last_updated": "1985-12-24T18:45:21.51Z", "encodingVersion": 1, "job": { "_id": "28b4b2e6a3e9528693d1c51c", "task": "b4f", "name": "myCoolDocumentName", "description": "Some helpful information about the document", "ancestors": null }, "incomingRefs": [], "groups": [ "a0ecc25f3619f0c9ee670aba" ], "type": "operation", "metrics": { "start_time": "adipisicing dolor Lorem cillum dolor", "end_time": -58988932.52741582, "server_id": "anim sit ut magna", "finish_state": "success", "run_time": -66589051.19198564, "retrying": true, "user": "", "owner": "Pronghorn" } }, { "_id": "fFD3c212-269A-bfc7-2Ded-fb6Bb24A071F", "location": "Broker", "view": "voluptate", "status": "paused", "app": "eiusmod ea mollit", "name": "in ad pariatur", "variables": { "decorators": [ { "type": "encryption", "pointer": "/Gb/~1" }, { "type": "encryption", "pointer": "/~1/~0/T1srB/~0/JBia4+Sl/iJAW8BQ7" }, { "type": "encryption", "pointer": "/aFkVb6" }, { "type": "encryption", "pointer": "/w1Hjl1x/l/~0/ZS" } ] }, "last_updated": "2012-05-22T00:45:56.842Z", "encodingVersion": 1, "job": { "_id": "5293cd31c59da80721189c86", "task": "3a1f", "name": "myCoolDocumentName", "description": "Some helpful information about the document", "ancestors": null }, "incomingRefs": [], "groups": [ { "_id": "829c81e5d29efbbc5ee7878e", "provenance": "ex", "name": "ea do", "description": "nulla eu ad", "memberOf": [ { "groupId": "29f716c62eeb34f5e39b47d8", "aaaManaged": false }, { "groupId": "b35c42a9e5e31cfe7da0d4cc", "aaaManaged": false }, { "groupId": "d2f1eee63189748ab0e4f2e2", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "officia" }, { "roleId": "deserunt cupidatat" }, { "roleId": "irure voluptate qui in" }, { "roleId": "ex tempor elit" }, { "roleId": "elit incididunt" } ], "inactive": true, "_meta": { "created": "1995-04-22T10:50:50.888Z", "updated": "1972-03-22T01:41:12.789Z", "migrationVersion": -27580615 } }, { "_id": "346ddd805f70cdef21ba7ec9", "provenance": "amet in dolor eiusmod", "name": "labore nisi in dolor minim", "description": "cupidatat amet culpa", "memberOf": [ { "groupId": "e7ed9ae91c0b7343f8cae38b", "aaaManaged": true }, { "groupId": "7222233f81867adb434e6831", "aaaManaged": true }, { "groupId": "5cfc2af34cb8b619db7e41c2", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "adipisicing est dolor" }, { "roleId": "qui eu non officia laboris" }, { "roleId": "irure commodo anim" }, { "roleId": "in adipisicing culpa anim" } ], "inactive": true, "_meta": { "created": "1989-09-10T20:08:31.452Z", "updated": "2008-08-13T21:15:27.659Z", "migrationVersion": 9122293 } }, { "_id": "9e4e0bff41c8b809e3f63c57", "provenance": "enim culpa ut", "name": "enim fugiat mollit nostrud ut", "description": "magna labore amet", "memberOf": [ { "groupId": "1bbb2ea46c7a2102bcb07e42", "aaaManaged": false }, { "groupId": "087613cf50ccd021e718dff7", "aaaManaged": true }, { "groupId": "f241da3f56933cdca5e259b8", "aaaManaged": true }, { "groupId": "6bb067d650e1f28c9f250b16", "aaaManaged": false }, { "groupId": "e99038f94a986a55e6972fa7", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "Lorem aliquip veniam magna" }, { "roleId": "mollit" }, { "roleId": "in dolore exercitation fugiat quis" }, { "roleId": "esse deserunt nulla dolor" }, { "roleId": "dolor culpa minim amet" } ], "inactive": false, "_meta": { "created": "2000-06-12T23:51:59.86Z", "updated": "2023-09-05T16:50:23.114Z", "migrationVersion": -91614919 } } ], "type": "operation", "metrics": { "start_time": "esse", "end_time": -18278806.08510247, "server_id": "ad laborum", "finish_state": "success", "run_time": -94310977.05657971, "retrying": false, "user": { "_id": "77eea61bcc804cd568b10e11", "provenance": "id", "username": "commodo", "firstname": "Lorem eiusmod id", "memberOf": [ { "groupId": "23e8f020976b9b312c2b36f8", "aaaManaged": false }, { "groupId": "2f60d0cb1974a10e64046053", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "in dolore" }, { "roleId": "do culpa consectetur proident non" }, { "roleId": "ex" }, { "roleId": "nisi" }, { "roleId": "do mollit voluptate qui" } ], "inactive": false, "lastLogin": "1954-03-08T11:56:14.384Z", "_meta": { "created": "2022-03-02T07:21:11.177Z", "updated": "1975-10-03T05:01:36.182Z", "migrationVersion": -60629246 }, "email": "commodo nisi eu in" }, "owner": "7a42d51a1a1474b6414095ab" } }, { "_id": "1DCebafC-9bAd-6133-bc4E-c25A36CAfa2a", "location": "Adapter", "view": "irure Duis aliqua nisi dolor", "status": "incomplete", "app": "eiusmod Excepteur ipsum consequat", "name": "cillum reprehenderit veniam", "variables": { "decorators": [ { "type": "encryption", "pointer": "/P/F5-WXA-07/RvP/~1/U7/~0" } ] }, "last_updated": "1987-05-11T17:13:22.561Z", "encodingVersion": 1, "job": { "_id": "2c9c2dbb34ff1be8f15f3d91", "task": "e28f", "name": "myCoolDocumentName", "description": "Some helpful information about the document", "ancestors": null }, "incomingRefs": [], "groups": [ { "_id": "6408cf3d5f83f157def7ccf3", "provenance": "sed", "name": "aliqua ut do", "description": "culpa voluptate sint exercitation adipisicing", "memberOf": [ { "groupId": "62de33b58ab8f9cfb580663a", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "ex Ut dolor ut dolore" } ], "inactive": false, "_meta": { "created": "1981-11-17T21:12:00.387Z", "updated": "1996-05-16T20:37:57.737Z", "migrationVersion": 28311274 } } ], "type": "operation", "metrics": { "start_time": "non eu minim incididunt", "end_time": 13957015.57268323, "server_id": "tempor aliquip do ut proident", "finish_state": "incomplete", "run_time": -13516922.451275453, "retrying": null, "user": "2467ed0d705984ef5e8a488c", "owner": "Pronghorn" } }, { "_id": "ffAcd7Aa-D308-4eDc-DFcd-251CbF3aA0Fd", "location": "Application", "view": null, "status": "error", "app": "dolor et irure dolore veniam", "name": "aute dolore ad aliquip", "variables": { "decorators": [ { "type": "encryption", "pointer": "/~0/WHHLW4/c2V9XIW/p/N/~0/xVjfCAk/u5Tzt82/~0" }, { "type": "encryption", "pointer": "/qCqm/FD/ib4YTsBp7HQ/~0/aG/Fe/" }, { "type": "encryption", "pointer": "/~0/~1/~0/~1/~1" } ] }, "last_updated": "2008-09-12T01:43:52.296Z", "encodingVersion": 1, "job": { "_id": "7ef65bdf9168bd5e8e288f1e", "task": "e28f", "name": "myCoolDocumentName", "description": "Some helpful information about the document", "ancestors": [ "b0d200fe810ede702620e89a", "927658d23ee1a06ed74d35f2", "dd7ad08e597ef5aa07f7092f", "a14b08bee4cda5204119b7b1", "86288e0b2652530df9e20f13" ] }, "incomingRefs": [], "groups": [ { "_id": "ffee4c5b74adb04ce644c73f", "provenance": "laboris", "name": "ipsum do eu magna", "description": "in sed", "memberOf": [ { "groupId": "22a3d01019e5c9f7b5edcae3", "aaaManaged": true }, { "groupId": "46a8cdfe125a87c819f275b7", "aaaManaged": false }, { "groupId": "78d99053a88d1d9a68531f81", "aaaManaged": true }, { "groupId": "f542a6dce836261a9927fe23", "aaaManaged": false }, { "groupId": "e6632c146089866a834ae46b", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "in ullamco" }, { "roleId": "Excepteur amet eu nulla" }, { "roleId": "eu" } ], "inactive": true, "_meta": { "created": "1999-03-02T07:29:48.497Z", "updated": "1998-02-03T01:59:14.652Z", "migrationVersion": 29230478 } }, { "_id": "7b43bb8774f97ad50a71e55f", "provenance": "Ut fugiat", "name": "amet", "description": "mollit", "memberOf": [ { "groupId": "c0b0acea308433849751f7ae", "aaaManaged": true }, { "groupId": "fcec467ba77f2dcbe649f83b", "aaaManaged": true }, { "groupId": "d1121f3e5735b75b6d0fd904", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "officia ea occaecat commodo" }, { "roleId": "in" }, { "roleId": "velit esse" }, { "roleId": "tempor" }, { "roleId": "laborum est" } ], "inactive": true, "_meta": { "created": "1970-01-12T13:21:05.237Z", "updated": "1980-03-14T18:07:28.905Z", "migrationVersion": 53892132 } }, "48212eae6a7025a9af20969b", { "_id": "25611db5369237fef6c2c71f", "provenance": "velit amet aliquip", "name": "in fugiat do est", "description": "anim sunt cillum", "memberOf": [ { "groupId": "979c24a55de04f9b344ff700", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "non" }, { "roleId": "eu Lorem" } ], "inactive": false, "_meta": { "created": "1975-01-03T08:14:47.199Z", "updated": "1972-01-04T04:59:13.527Z", "migrationVersion": 67384448 } }, { "_id": "30beb95b67067ad06baaefd2", "provenance": "Lorem sint ut ullamco", "name": "non dolor incididunt ex dolor", "description": "ipsum incididunt culpa Ut", "memberOf": [ { "groupId": "ebb6b25fe2b3e2fc25b12fbf", "aaaManaged": true }, { "groupId": "515262180f74d2dc9dd2ef26", "aaaManaged": true }, { "groupId": "21a9072f7c1f5f959051c9d9", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "deserunt" } ], "inactive": false, "_meta": { "created": "1986-11-30T05:44:11.09Z", "updated": "1957-06-29T08:46:08.289Z", "migrationVersion": -28758049 } } ], "type": "operation", "metrics": { "start_time": "non", "end_time": -62346025.96652979, "server_id": "Lorem amet et ipsum aute", "finish_state": "canceled", "run_time": -88666230.1768046, "retrying": null, "user": "Pronghorn", "owner": "Pronghorn" } }, { "_id": "8D92bb20-51AA-091D-8A29-5DDe7a57b19E", "location": "Adapter", "view": null, "status": "complete", "app": "aliquip esse proident nulla", "name": "nostrud", "variables": { "decorators": [ { "type": "encryption", "pointer": "/I,AT3/CVjtdTc/~0/W/~0/qqi/~1" }, { "type": "encryption", "pointer": "/~0/~1" }, { "type": "encryption", "pointer": "/~1/~0/~1" } ] }, "last_updated": "1968-12-26T11:27:48.382Z", "encodingVersion": 1, "job": { "_id": "8b25b95baf4d09df64ce0694", "task": "e28f", "name": "myCoolDocumentName", "description": "Some helpful information about the document", "ancestors": [ "4ed8782cc539ac93072f816f", "bd07235693559ee55ba8dfd6", "f47ef2e1a66965682bdaaa02", "171683bfe3dc3b1be4446faa" ] }, "incomingRefs": [], "groups": [ "7b34207b0ffa7274478fe126", { "_id": "4edabdf7b54d2bea88b1a512", "provenance": "Lorem commodo", "name": "elit", "description": "non Duis esse", "memberOf": [ { "groupId": "4b8dfcc93bb6fd3fc6121d97", "aaaManaged": false }, { "groupId": "13532a03371d18d52112125a", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "Excepteur consequat ex" }, { "roleId": "consectetur ipsum voluptate" }, { "roleId": "do" } ], "inactive": true, "_meta": { "created": "1946-02-27T19:08:03.131Z", "updated": "1985-07-05T14:31:35.118Z", "migrationVersion": 47015423 } }, "e7939e0364775f86bdc49e56", "dcedea64e2b2a3e5f59134f9", "490c750e6a527f65d21f06da" ], "type": "operation", "metrics": { "start_time": "id minim enim sunt", "end_time": 22241521.443340063, "server_id": "aliquip nulla cillum non", "finish_state": "error", "run_time": 36464166.30288732, "retrying": null, "user": "f0911dce63bc8326d9bef283", "owner": "Pronghorn" } } ], "metadata": { "skip": 74907526, "limit": -89452372, "total": 33196344, "nextPageSkip": null, "previousPageSkip": null, "currentPageSize": 24677647 } }
{ "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" } } } ] }