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": 10, "order": 1, "sort": "name", "include": "name,description", "exclude": "description", "in": "dolor", "not-in": "id irure", "equals": "deserunt ullamco ut laborum", "contains": "do amet", "starts-with": "cupidatat dolor exercitation minim commodo", "ends-with": "ut anim", "dereference": "sint in pariatur commodo Lorem", "gt": "dolor Ut consectetur sint Excepteur", "gte": "proident voluptate ut laboris", "lt": "cupidatat nostrud exercitation aliqua Duis", "lte": "dolore pariatur", "q": "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": "7B2fbB41-D08E-e8FF-5B6a-35A3a91A5E5d", "location": "Application", "view": "ad elit incididunt", "status": "incomplete", "app": "officia sed veniam Lorem", "name": "tempor aliqua sit adipisicing", "variables": { "decorators": [ { "type": "encryption", "pointer": "/Xm/~1" }, { "type": "encryption", "pointer": "/~0/~0/~0/XORtZMOkmH" }, { "type": "encryption", "pointer": "/litfNNV/YX,9b9/L+8/D/~1/~0" } ] }, "last_updated": "1985-05-19T03:06:58.399Z", "encodingVersion": 1, "job": { "_id": "c230378de0c7a23064ac3a0a", "task": "b4f", "name": "myCoolDocumentName", "description": "Some helpful information about the document", "ancestors": null }, "groups": [ "55cd59c0fe01d6def12cb07e", "9f637842edc38d4ef7952c75" ], "type": "operation", "metrics": { "start_time": "Excepteur est labore", "end_time": -65308611.75017804, "server_id": "occaecat dolor ipsum anim", "finish_state": "running", "run_time": -56663237.00903555, "retrying": null, "user": "dea1fc66c22977340481ebb8", "owner": "" } }, { "_id": "b1cE1bd8-139e-aaF4-6D87-6794Fd08dcE2", "location": "Broker", "view": null, "status": "canceled", "app": "in labore sit officia", "name": "ullamco aute occaecat Duis ipsum", "variables": { "decorators": [ { "type": "encryption", "pointer": "/~1/HOzjMd/mNhH/~1/m-6tz4F/Cfka//RG8MCx/~1" }, { "type": "encryption", "pointer": "/~0/YTSic6fdSzI/W3/~1/~1/~0/IVN/ZZ2eCZilw/HnRaXB" }, { "type": "encryption", "pointer": "/~0/~1/OhKskWorzy/~1/Xx/~0/xUUovx" } ] }, "last_updated": "2008-05-22T22:20:22.097Z", "encodingVersion": 1, "job": { "_id": "439c6388ea7ab301629b0ccc", "task": "b4f", "name": "myCoolDocumentName", "description": "Some helpful information about the document", "ancestors": null }, "groups": [ "f2dec6329b7fba13dbb4ac6f", { "_id": "227e366c003dfc488399267f", "provenance": "Lorem", "name": "veniam et est", "description": "laboris fugiat Lorem deserunt dolor", "memberOf": [ { "groupId": "0d204b3509a33a3390d4e970", "aaaManaged": true }, { "groupId": "fd8a7e63888afd4552be6623", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "ea dolor aute culpa aliquip" }, { "roleId": "dolor" }, { "roleId": "laboris" } ], "inactive": true, "_meta": { "created": "1954-03-13T08:48:14.501Z", "updated": "2001-03-08T17:27:29.273Z", "migrationVersion": -77430899 } }, { "_id": "d6d2aa7b756eba880d20f97c", "provenance": "nulla labore ullamco aliquip", "name": "velit", "description": "esse in voluptate tempor", "memberOf": [ { "groupId": "fa60835e04719f3899828b3e", "aaaManaged": false }, { "groupId": "51e256c0f73e8ea6df6a6d1a", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "cillum aliqua" }, { "roleId": "ea ipsum fugiat" }, { "roleId": "dolor cupidatat aliquip adipisicing" } ], "inactive": true, "_meta": { "created": "1986-08-25T14:58:25.618Z", "updated": "1989-09-30T04:38:29.968Z", "migrationVersion": -24881615 } }, { "_id": "457a782d3c6a230b7bbe461d", "provenance": "culpa", "name": "in et reprehenderit anim", "description": "nulla fugiat", "memberOf": [ { "groupId": "162c01b60d0a8dba850c2f84", "aaaManaged": true }, { "groupId": "425e248044944856f76d8ed5", "aaaManaged": false }, { "groupId": "5c804cf7c43f2e4f5193eed8", "aaaManaged": true }, { "groupId": "b78577f5b95baf198e18b747", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "exercitation ut occaecat culpa ea" } ], "inactive": true, "_meta": { "created": "1996-10-06T02:54:02.678Z", "updated": "1973-07-06T19:39:15.548Z", "migrationVersion": 22798739 } }, "1a579a1b253facbd98a288b9" ], "type": "operation", "metrics": { "start_time": "voluptate ullamco dolor nostrud", "end_time": 43051942.80836591, "server_id": "fugiat nostrud sunt irure elit", "finish_state": "error", "run_time": 180806.81480818987, "retrying": true, "user": { "_id": "fbef4ac010645312a41c770f", "provenance": "do ea", "username": "sed dolor", "firstname": "ex cillum anim in reprehenderit", "memberOf": [ { "groupId": "615649c01a8efdc30ed6660f", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "laboris elit" } ], "inactive": true, "lastLogin": "1946-05-01T01:49:46.711Z", "_meta": { "created": "1997-12-06T23:25:42.616Z", "updated": "1964-10-26T07:12:32.781Z", "migrationVersion": -92803608 }, "email": "sunt cillum voluptate ipsum" }, "owner": "" } }, { "_id": "bEcaf703-baaa-6d27-215A-78b8aF13ED5C", "location": "Adapter", "view": "magna consequat pariatur deserunt", "status": "paused", "app": "consequat incididunt commodo exercitation", "name": "ex officia dolor", "variables": { "decorators": [ { "type": "encryption", "pointer": "/XGKtt5Im/~0/~1/k4wTbIX9tU" }, { "type": "encryption", "pointer": "/qS/~0/~1/~1/~0" }, { "type": "encryption", "pointer": "/~1/~0/dX/lcRBy0jo" }, { "type": "encryption", "pointer": "/RiC/~1/crnFE+d7zAh/k3QxeMbU4/~1/~1/~1/~1/ANP3yYS3N" }, { "type": "encryption", "pointer": "/ru3wNI" } ] }, "last_updated": "1991-02-27T06:44:26.035Z", "encodingVersion": 1, "job": { "_id": "a7c2b6f61769764d3914b22e", "task": "3a1f", "name": "myCoolDocumentName", "description": "Some helpful information about the document", "ancestors": null }, "groups": [ { "_id": "0fbb40e87c4b64fe473d120e", "provenance": "Duis sit laboris sunt eu", "name": "esse officia", "description": "aliqua ut labore sint do", "memberOf": [ { "groupId": "98bc2c1301d8a276d8e72f08", "aaaManaged": false }, { "groupId": "f64adffdd1850ee63681950c", "aaaManaged": true }, { "groupId": "6d7a8aef2faf09d0977928dc", "aaaManaged": false }, { "groupId": "fa0355e332558731825f4862", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "ipsum ad incididunt" }, { "roleId": "magna culpa dolore" }, { "roleId": "esse culpa" }, { "roleId": "culpa sed" } ], "inactive": true, "_meta": { "created": "1994-04-22T02:27:16.963Z", "updated": "1989-07-17T22:17:28.651Z", "migrationVersion": -46062700 } } ], "type": "operation", "metrics": { "start_time": "id eiusmod velit irure labore", "end_time": 73376919.19696021, "server_id": "dolor", "finish_state": "canceled", "run_time": -90732214.85778107, "retrying": false, "user": "Pronghorn", "owner": { "_id": "c4cf2cd1c37300dd27b1dba7", "provenance": "fugiat sed", "username": "consequat cupidatat aliqua culpa", "firstname": "aute sunt dolore Ut sint", "memberOf": [ { "groupId": "8365b4a0cbfed9432396ba7f", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "cupidatat in velit proident" }, { "roleId": "nostrud" } ], "inactive": true, "lastLogin": "1963-03-15T01:07:20.558Z", "_meta": { "created": "1947-12-16T02:08:45.783Z", "updated": "2004-05-06T15:40:53.404Z", "migrationVersion": -99945552 }, "email": "elit magna in incididunt" } } }, { "_id": "BCf5D4af-fb9C-B76d-FcD9-Acfaea036A8c", "location": "Broker", "view": "nisi fugiat dolore in", "status": "error", "app": "Duis nostrud", "name": "laborum officia et magna", "variables": { "decorators": [ { "type": "encryption", "pointer": "/A/~1/~0/~0" }, { "type": "encryption", "pointer": "/R/UBg/~0/C6eFyMMv,/QHQFc+UV/ixIvX3m7t/Uwqt,I3jSxs/~1/~1/~1/~0" } ] }, "last_updated": "2010-05-31T07:22:22.639Z", "encodingVersion": 1, "job": { "_id": "8cbf3aafa2bba68e9067eafd", "task": "e28f", "name": "myCoolDocumentName", "description": "Some helpful information about the document", "ancestors": null }, "groups": [ { "_id": "b212f2066c3397d42911337a", "provenance": "aliquip tempor", "name": "aliqua tempor magna ad nulla", "description": "in", "memberOf": [ { "groupId": "3cc451994b64b508872a1dcf", "aaaManaged": false }, { "groupId": "ba6ddf7f4d1a6c436e879c38", "aaaManaged": true }, { "groupId": "47f345c8dc20185e46c9390b", "aaaManaged": true }, { "groupId": "ee2e927c1d975117ec24ea5f", "aaaManaged": true }, { "groupId": "90675dca32d290088a786a78", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "ut voluptate eu aute in" }, { "roleId": "nostrud officia minim eu incididunt" }, { "roleId": "deserunt eiusmod nisi Excepteur culpa" }, { "roleId": "laborum reprehenderit exercitation proident laboris" }, { "roleId": "et dolor in" } ], "inactive": true, "_meta": { "created": "2017-05-20T18:19:47.765Z", "updated": "1992-11-18T15:38:54.154Z", "migrationVersion": 86031094 } }, "e8e689492729eb6d01b222aa", "86894f93f3faf719602ac3c9", "1cffaac1fa1c310be89b5ab9" ], "type": "operation", "metrics": { "start_time": "proident ut laboris minim", "end_time": -95024557.25866184, "server_id": "nisi nostrud occaecat incididunt", "finish_state": "success", "run_time": 73103093.68426648, "retrying": null, "user": "e7bf8d796e7a62cbdf330c3d", "owner": { "_id": "1f41141cf12659240cbc29fa", "provenance": "pariatur eiusmod nulla", "username": "ipsum voluptate", "firstname": "voluptate", "memberOf": [ { "groupId": "c9e0498371c62d99c4e7097d", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "eu" }, { "roleId": "mollit enim eiusmod commodo" }, { "roleId": "id ad ut non consectetur" }, { "roleId": "deserunt anim" } ], "inactive": true, "lastLogin": "2001-01-10T20:33:36.673Z", "_meta": { "created": "1990-03-06T18:34:57.918Z", "updated": "1993-09-10T16:40:11.039Z", "migrationVersion": 47043197 }, "email": "id deserunt dolore exercitation quis" } } } ], "metadata": { "skip": 23257456, "limit": -64001858, "total": 72355067, "nextPageSkip": -84421675, "previousPageSkip": null, "currentPageSize": 89722699 } }
{ "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" } } } ] }