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": 1, "order": 1, "sort": "name", "include": "description", "exclude": "description", "in": "adipisicing", "not-in": "dolor ad quis", "equals": "irure dolore in", "contains": "adipisicing", "starts-with": "ut eu in", "ends-with": "do", "dereference": "ullamco", "gt": "deserunt ullamco cillum ad", "gte": "sed nostrud sint id", "lt": "veniam laborum velit pariatur reprehenderit", "lte": "ullamco quis esse irure veniam", "q": "aute cupidatat ullamco", "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 imported 3 of 4 documents", "data": [ { "_id": "deCbBdE2-9827-8305-d42f-e142Fdc29B9f", "location": "Adapter", "view": "esse sint ipsum sed magna", "status": "running", "app": "Lorem", "name": "culpa non sunt aliquip", "variables": { "decorators": [ { "type": "encryption", "pointer": "/elCbn7r/F2By6Z/D6s1/Sk" }, { "type": "encryption", "pointer": "/TF/yYjSmSb/Roqd7k+/DKKomc/K5I+gwjJ" } ] }, "last_updated": "1951-10-18T02:14:39.942Z", "encodingVersion": 1, "job": { "_id": "f2e8a078993a704222200ec5", "task": "3a1f", "name": "myCoolDocumentName", "description": "Some helpful information about the document", "ancestors": null }, "groups": [ { "_id": "285ab717643e52227486181b", "provenance": "do ea esse", "name": "Excepteur sunt minim fugiat", "description": "ipsum ut deserunt laborum et", "memberOf": [ { "groupId": "6a61215098e84b4d00a5e49a", "aaaManaged": false }, { "groupId": "40c6439c968bcf2e727cbaeb", "aaaManaged": true }, { "groupId": "87fb64bce9c777023017bef6", "aaaManaged": true }, { "groupId": "a09afb8ceeee945cd59a6cd6", "aaaManaged": true }, { "groupId": "61850c8a62befca0a308f327", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "proident magna consequat anim" }, { "roleId": "amet ad" }, { "roleId": "in culpa Duis fugiat" }, { "roleId": "laborum non pariatur occaecat sed" } ], "inactive": true, "_meta": { "created": "1957-03-02T04:44:58.148Z", "updated": "2012-05-12T02:21:08.178Z", "migrationVersion": 61189044 } }, { "_id": "1635e90298de8d3addd6c84e", "provenance": "aute ad officia incididunt cillum", "name": "Excepteur deserunt Ut reprehenderit ullamco", "description": "ipsum non sed Lorem", "memberOf": [ { "groupId": "51fa906b2fc0a878b4c168c2", "aaaManaged": true }, { "groupId": "bede237a63c4d5cef7aa06ea", "aaaManaged": true }, { "groupId": "37a8e143fc02f6ee70e8dcd0", "aaaManaged": false }, { "groupId": "7da5eccff2809ffef2bfd46a", "aaaManaged": false }, { "groupId": "c40487fafb83cf5f0451ffa4", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "est tempor officia in minim" }, { "roleId": "dolor deserunt mollit" }, { "roleId": "nulla pariatur sit labore" }, { "roleId": "Excepteur dolor eu esse culpa" }, { "roleId": "dolore velit aute" } ], "inactive": false, "_meta": { "created": "1995-10-24T15:42:41.86Z", "updated": "1957-03-25T08:55:01.299Z", "migrationVersion": -41619109 } } ], "type": "operation", "metrics": { "start_time": "consectetur dolore labore ad mollit", "end_time": 14688292.658817172, "server_id": "consectetur eu aliquip ipsum", "finish_state": "incomplete", "run_time": 45573849.46882835, "retrying": null, "user": "", "owner": "Pronghorn" } }, { "_id": "BBd1fe9A-B2cA-515e-B9FB-C8b509e1e29d", "location": "Adapter", "view": "mollit", "status": "paused", "app": "reprehenderit fugiat id", "name": "minim est", "variables": { "decorators": [ { "type": "encryption", "pointer": "/WYliV/~1/O/Xu/Jvl+/~0/C/xk" }, { "type": "encryption", "pointer": "/~0/~1/f/G3+J+NU/~0/~0/rSHsAzx/~1/Z03X6w/~0/~0" }, { "type": "encryption", "pointer": "/~0/~1/aNCz/~1" }, { "type": "encryption", "pointer": "/coHn/a,jFY/Q/xq3YY,W/~1/~0/~1" } ] }, "last_updated": "2022-12-15T09:36:24.18Z", "encodingVersion": 1, "job": { "_id": "48e7ebe8a48f3bd37ab02eb9", "task": "b4f", "name": "myCoolDocumentName", "description": "Some helpful information about the document", "ancestors": [ "eb777b67c5ede62d02a8fded", "6d95defca3c42ea369b965db", "31c175f6be13abb91d64dff2", "3ead35ef5072124541692e57", "5b8f15cbb806b9584a06876d" ] }, "groups": [ { "_id": "5066163d217f5110b97e1a5f", "provenance": "mollit nisi in", "name": "dolor nostrud nulla sed velit", "description": "ex est", "memberOf": [ { "groupId": "d2f5454f71f3fbc2d0d0755b", "aaaManaged": true }, { "groupId": "3954e44d15fb0b7e267f5889", "aaaManaged": true }, { "groupId": "d6271a9f0ddd314b2fcc7f95", "aaaManaged": true }, { "groupId": "117c1b2b710c40b735c41fbd", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "aute ex elit sit" }, { "roleId": "minim" }, { "roleId": "dolor labore" }, { "roleId": "sunt ut est" }, { "roleId": "ad aute" } ], "inactive": true, "_meta": { "created": "1975-08-16T15:04:15.244Z", "updated": "1995-08-31T12:49:16.098Z", "migrationVersion": -38374436 } }, { "_id": "f5e69081d5365aeeeff870f3", "provenance": "non quis incididunt adipisicing", "name": "Lorem in exercitation nulla", "description": "voluptate", "memberOf": [ { "groupId": "0cd8a33e51d13b7a564d63ce", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "officia mollit" }, { "roleId": "sit laborum aute ut" }, { "roleId": "ut Excepteur" } ], "inactive": true, "_meta": { "created": "1962-10-23T21:44:11.309Z", "updated": "1975-07-22T10:52:58.709Z", "migrationVersion": 64813449 } }, { "_id": "30ed2c563f67c05dbfb9c550", "provenance": "pariatur ut dolore", "name": "eu sed", "description": "officia incididunt aliqua ex", "memberOf": [ { "groupId": "175aa6294a9c953598512508", "aaaManaged": true }, { "groupId": "edc93002f658cdd4787f95ac", "aaaManaged": false }, { "groupId": "79343266b3bdf5cd0d7d68ba", "aaaManaged": true }, { "groupId": "7b754a0217dc347022621f87", "aaaManaged": false }, { "groupId": "71c3da589d21874c9bec9130", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "Duis amet consequat" } ], "inactive": false, "_meta": { "created": "2015-07-19T01:04:28.528Z", "updated": "2013-03-26T11:48:28.157Z", "migrationVersion": -81255032 } }, "3f6bc0b04ccf2f77226fce78" ], "type": "operation", "metrics": { "start_time": "Lorem mollit", "end_time": -2500500.4188602567, "server_id": "do in esse sed", "finish_state": "canceled", "run_time": -95915485.56261045, "retrying": null, "user": { "_id": "f20368895283849314eb1763", "provenance": "ea velit magna", "username": "amet officia", "firstname": "irure", "memberOf": [ { "groupId": "46d9f03d484f30ba043bfcc8", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "ex laboris deserunt dolor" }, { "roleId": "cupidatat quis reprehenderit Duis ut" }, { "roleId": "pariatur elit sint nisi" } ], "inactive": true, "lastLogin": "1957-02-10T07:43:37.984Z", "_meta": { "created": "1992-12-09T08:23:00.279Z", "updated": "2014-02-12T07:07:17.627Z", "migrationVersion": -62742913 }, "email": "dolore sed labore ea" }, "owner": { "_id": "36a0bd558ed500b61bdf6628", "provenance": "aute nulla officia", "username": "cupidatat commodo culpa aute dolor", "firstname": "in dolore sint", "memberOf": [ { "groupId": "ccc9f2d3e1d300bce7d60aaf", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "minim cupidatat" }, { "roleId": "adipisicing do ullamco" } ], "inactive": true, "lastLogin": "1984-02-22T18:58:04.935Z", "_meta": { "created": "1995-10-07T05:48:00.896Z", "updated": "1957-03-27T15:42:21.295Z", "migrationVersion": -91937195 }, "email": "aliqua laborum sint" } } }, { "_id": "cDB4c7D9-C0aA-46fF-c64B-b0bE6ECEfcBB", "location": "Broker", "view": null, "status": "paused", "app": "in velit id ea", "name": "amet ut do", "variables": { "decorators": [ { "type": "encryption", "pointer": "/WCvNNpv7/w/~0/M8,P-qJn/~1/~0" }, { "type": "encryption", "pointer": "/C5eIMnu/S0bVL5W1fK/~1/~0" }, { "type": "encryption", "pointer": "/EOh+7/Q0vTg/~0/~0/~1/qhv-KcVVC" }, { "type": "encryption", "pointer": "/~0/il1Bs/TmE07/~1" }, { "type": "encryption", "pointer": "/~1/v0/Ej6/nNc1+/~0/~0/Zp6TIKZtLE/jWyr/dU2EetUV0Y/JffqN/PnM" } ] }, "last_updated": "1946-11-21T14:26:54.923Z", "encodingVersion": 1, "job": { "_id": "2b4f5f6ea9d71bea84ad8005", "task": "e28f", "name": "myCoolDocumentName", "description": "Some helpful information about the document", "ancestors": [ "8847ec342cadb357686a51f4", "51b97f2e7ada4c90cabe4076" ] }, "groups": [ { "_id": "cf1b697107e93aeb9741c908", "provenance": "quis adipisicing tempor in aute", "name": "cupidatat nostrud", "description": "in ipsum incididunt minim", "memberOf": [ { "groupId": "94c101f43be2f0f6674d33db", "aaaManaged": true }, { "groupId": "1fca809823ef8096e1f0fa5a", "aaaManaged": false }, { "groupId": "f4d7d649e472f74a4cd0b871", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "velit" }, { "roleId": "tempor pariatur eiusmod reprehenderit" }, { "roleId": "sunt in cupidatat non adipisicing" }, { "roleId": "esse mollit consectetur nostrud" } ], "inactive": true, "_meta": { "created": "2017-01-09T08:31:52.65Z", "updated": "2007-03-04T14:54:21.522Z", "migrationVersion": 1983836 } }, { "_id": "76eedc7c55e413758f00b651", "provenance": "veniam deserunt occaecat irure magna", "name": "officia ipsum pariatur ea dolore", "description": "adipisicing Duis in non Ut", "memberOf": [ { "groupId": "85a587377767426738fe068c", "aaaManaged": true }, { "groupId": "03b0619b8eec1a046625a417", "aaaManaged": true }, { "groupId": "97ec3baf40db2b3af2f6cb42", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "incididunt pariatur sit fugiat deserunt" }, { "roleId": "consequat esse magna" }, { "roleId": "culpa aliquip" } ], "inactive": false, "_meta": { "created": "1966-08-05T09:58:55.957Z", "updated": "2005-09-09T17:26:05.188Z", "migrationVersion": 46829849 } }, { "_id": "58891cfe12fcaf45709079dd", "provenance": "in eiusmod tempor proident dolor", "name": "non in ex", "description": "id in commodo", "memberOf": [ { "groupId": "b898b7d2970c8533d8989295", "aaaManaged": false }, { "groupId": "528e37c0f1af06ce33ab5a57", "aaaManaged": false }, { "groupId": "faff7ee02827382a1194945b", "aaaManaged": false }, { "groupId": "3a122248d4e43a1823f06729", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "dolor adipisicing esse in deserunt" }, { "roleId": "velit dolore fugiat" } ], "inactive": false, "_meta": { "created": "2011-07-22T09:12:26.163Z", "updated": "1959-06-12T07:27:36.407Z", "migrationVersion": 55502608 } }, "de2d0c42d94d2e7ec3b47477", "9a358e7f6d2217db0a12f27e" ], "type": "operation", "metrics": { "start_time": "cillum eu non id", "end_time": 29102791.360867113, "server_id": "laborum ad in", "finish_state": "failure", "run_time": 65574876.80666742, "retrying": true, "user": "664997982213ee2dec676eb8", "owner": "dd33799beebf59da7fdc8109" } } ], "metadata": { "skip": -90354799, "limit": -29289622, "total": -43428617, "nextPageSkip": null, "previousPageSkip": null, "currentPageSize": 33163964 } }
{ "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" } } } ] }