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": 10, "order": 1, "sort": "name", "include": "name", "exclude": "_id,description", "in": "esse reprehenderit Lorem", "not-in": "eiusmod incididunt", "equals": "est amet deserunt", "contains": "proident in nisi Duis veniam", "starts-with": "mollit", "ends-with": "dolor consectetur", "dereference": "voluptate ipsum ad", "gt": "id", "gte": "et sunt Duis Excepteur minim", "lt": "nulla", "lte": "eu", "q": "ea", "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 created the requested item", "data": [ { "_id": "Ea8c0F0b-ef6c-7293-9d9e-dB6fDff254B8", "location": "Application", "view": null, "status": "running", "app": "aute sed ad id", "name": "id mollit ut nulla", "variables": { "decorators": [ { "type": "encryption", "pointer": "/~0/~1/AVwu/~0/~0/~0/zX7T9" }, { "type": "encryption", "pointer": "/~0/~0/~0/~1/~1/iyOkY7SM" }, { "type": "encryption", "pointer": "/~1/~1/~1" }, { "type": "encryption", "pointer": "/L1/~0" } ] }, "last_updated": "1976-04-16T16:01:40.551Z", "encodingVersion": 1, "job": { "_id": "e06dc08573ac8994d9e5c161", "task": "e28f", "name": "myCoolDocumentName", "description": "Some helpful information about the document", "ancestors": [ "29597fcb35653d8f5d028d52", "4faaee70cf68751ce25184c7", "ec5ca26ba9355d06c696819b", "25173686cf60dc3f511a3b38", "12eef045003732f72eea3f37" ] }, "groups": [ "576ed6e9832bb5071ee77e1e", "3250d4900cba68a40965d374", "23bc27fa874db6ffa4402015", { "_id": "c5b293c29fb9fce787622877", "provenance": "commodo ad voluptate", "name": "enim ex in", "description": "aliqua sint Duis", "memberOf": [ { "groupId": "c282a49dbbc898e089f9af24", "aaaManaged": true }, { "groupId": "3fc392abf921204283d85d49", "aaaManaged": false }, { "groupId": "28f20f23bb8c3e2398cbab01", "aaaManaged": false }, { "groupId": "458459e3e73848156926c6c7", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "minim Ut aliqua reprehenderit officia" } ], "inactive": true, "_meta": { "created": "1963-11-16T19:46:06.758Z", "updated": "2012-12-01T19:10:42.212Z", "migrationVersion": -84162726 } }, { "_id": "72902db4531ab31a02d439e3", "provenance": "Lorem", "name": "proident", "description": "commodo eiusmod proident pariatur nulla", "memberOf": [ { "groupId": "dc7fb735e06c12fd6bc255e0", "aaaManaged": false }, { "groupId": "dc8d4a4deed01f9f0d926c1f", "aaaManaged": false }, { "groupId": "437bb43e2b5bfc5f61d70f1b", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "ut velit enim labore irure" }, { "roleId": "dolore" }, { "roleId": "do" } ], "inactive": false, "_meta": { "created": "2015-12-30T23:55:16.174Z", "updated": "1974-09-23T07:44:35.816Z", "migrationVersion": 25200079 } } ], "type": "automatic", "metrics": { "start_time": "id", "end_time": 75658439.28778017, "server_id": "aute laboris nulla dolore occaecat", "finish_state": "canceled", "run_time": 1017190.1576141864, "retrying": true, "user": { "_id": "6b809d7c5671e0fb5991c4c4", "provenance": "anim", "username": "pariatur dolor ad enim cillum", "firstname": "anim nostrud", "memberOf": [ { "groupId": "a33811633d78ae10362874d5", "aaaManaged": true }, { "groupId": "13dd675d2b457b7c1a6188da", "aaaManaged": true }, { "groupId": "f9d654eed48b151d643743b4", "aaaManaged": false }, { "groupId": "d9e0f7d8debb69e7fe814c72", "aaaManaged": false }, { "groupId": "a90f5f5391ff3421359c0ca7", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "pariatur anim voluptate" } ], "inactive": false, "lastLogin": "1982-02-23T01:21:39.958Z", "_meta": { "created": "2024-07-02T11:29:58.556Z", "updated": "1968-06-14T03:37:27.784Z", "migrationVersion": -37118662 }, "email": "veniam reprehenderit" }, "owner": { "_id": "eb6216709e4ea6df93cfa22d", "provenance": "dolore esse laboris", "username": "labore ut", "firstname": "cupidatat amet ipsum", "memberOf": [ { "groupId": "36c9947b398a7a45bc3a2fcb", "aaaManaged": false }, { "groupId": "0ecc18c53df8131cdc9df439", "aaaManaged": true }, { "groupId": "7b80529c451fb172b2a5b377", "aaaManaged": false }, { "groupId": "e01ee8dfb16d8d367c983e2f", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "ex in ullamco consectetur pariatur" } ], "inactive": false, "lastLogin": "1964-05-16T14:42:42.592Z", "_meta": { "created": "1978-08-12T01:24:37.801Z", "updated": "2008-02-06T09:31:16.858Z", "migrationVersion": 51435242 }, "email": "aliquip" } } }, { "_id": "0A57dBB5-b9Ea-e302-E79B-cd2Bbe5aa1Ac", "location": "Application", "view": "ad aliqua id Duis nostrud", "status": "complete", "app": "cillum eu nisi in", "name": "qui", "variables": { "decorators": [ { "type": "encryption", "pointer": "/Be/TKZJjk+qB/~1" }, { "type": "encryption", "pointer": "/~1/SqhM1C8Utf/~1/~0/h0U,2L0" }, { "type": "encryption", "pointer": "/~1/~0/~1/~0/JBTRF" }, { "type": "encryption", "pointer": "/~1/~0/CEyCE34-/d/~0/~1/~0/~0/DIK" }, { "type": "encryption", "pointer": "/~0/Q3/~0/~0/yuXiC3PP/n872Jnitg/~0/qK/ERyCan5-2P/b-gbd" } ] }, "last_updated": "1973-02-13T23:49:31.743Z", "encodingVersion": 1, "job": { "_id": "fbd2fde422e0710baf5f7259", "task": "b4f", "name": "myCoolDocumentName", "description": "Some helpful information about the document", "ancestors": [ "7c894119c9c24f553a1b530c", "011619589fb9c23a0c6a77d6", "3134ed9801df451fa6a5ad06", "02951c6267e41210fb466082", "ed6075731909ac98b0d3e931" ] }, "groups": [ "c54b60419c58b649a3526597", { "_id": "bb0ba5e97d79753356c4aa64", "provenance": "qui id sed", "name": "nulla velit deserunt et", "description": "officia", "memberOf": [ { "groupId": "4ed00275ccb2b15634f42be9", "aaaManaged": true }, { "groupId": "ccd34935d0af70ea393289dd", "aaaManaged": false }, { "groupId": "1fbe2b4b67d1178097ea98c4", "aaaManaged": false }, { "groupId": "32a645abb13bab52043fcb98", "aaaManaged": false }, { "groupId": "e69449aefb5575d1320a27ae", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "elit Duis" }, { "roleId": "elit culpa" }, { "roleId": "proident" }, { "roleId": "adipisicing" } ], "inactive": true, "_meta": { "created": "2006-12-30T17:25:22.328Z", "updated": "1975-11-03T07:20:02.971Z", "migrationVersion": 33817882 } }, { "_id": "97a4d53dca5efd9c16182422", "provenance": "in", "name": "veniam consectetur mollit commodo", "description": "eu ullamco", "memberOf": [ { "groupId": "329c160ca1aa255cfbd85d20", "aaaManaged": true }, { "groupId": "e1f2e9b815fa666c35fcc810", "aaaManaged": true }, { "groupId": "5b38a7ab52b780e4d5e2475d", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "occaecat ipsum incididunt ea labore" }, { "roleId": "aute Ut ut ipsum" }, { "roleId": "dolore aliqua veniam magna velit" } ], "inactive": false, "_meta": { "created": "1958-10-15T21:06:10.432Z", "updated": "2012-07-22T20:14:36.956Z", "migrationVersion": -67046331 } }, { "_id": "5ba9eae4371ebf22bb3d9a0b", "provenance": "dolor laborum fugiat labore commodo", "name": "labore", "description": "Duis occaecat cupidatat ad id", "memberOf": [ { "groupId": "2a5d92e7b11dc38db9ef70bb", "aaaManaged": true }, { "groupId": "2f60f2954f720e835be87d0a", "aaaManaged": true }, { "groupId": "3cfd696de6398f7e8bf60d13", "aaaManaged": true }, { "groupId": "e6d9e0ffed28f2b917b56d94", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "magna laboris nisi in ad" } ], "inactive": true, "_meta": { "created": "1996-07-01T17:17:42.146Z", "updated": "1982-02-13T01:20:43.493Z", "migrationVersion": 56877005 } }, { "_id": "86bb0bab76bb1f42b57bacd5", "provenance": "ad veniam", "name": "amet anim tempor culpa deserunt", "description": "ea aliquip ut", "memberOf": [ { "groupId": "ba81de0096a7cac552c41a98", "aaaManaged": false }, { "groupId": "746cb8dc78dbcd2bb7b2125f", "aaaManaged": false }, { "groupId": "b0c111215ef4c02ee98454d9", "aaaManaged": true }, { "groupId": "576682bfad542a4e651ac4a2", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "aliqua exercitation sunt Ut non" } ], "inactive": false, "_meta": { "created": "1970-04-21T21:48:09.075Z", "updated": "2007-11-30T17:22:16.09Z", "migrationVersion": -1767731 } } ], "type": "automatic", "metrics": { "start_time": "adipisicing et tempor elit nostrud", "end_time": -53022697.12261798, "server_id": "veniam Ut deserunt Lorem minim", "finish_state": "success", "run_time": -53672151.96534647, "retrying": null, "user": { "_id": "8ec6d4eb4493a31a555333b8", "provenance": "anim qui voluptate ut veniam", "username": "culpa", "firstname": "dolore non nisi", "memberOf": [ { "groupId": "6c15aa59720fa4232187e571", "aaaManaged": true }, { "groupId": "1b9fec4e8eb83b86c4ace609", "aaaManaged": false }, { "groupId": "cbd9b04cdd4bb7bfa97e8a15", "aaaManaged": true }, { "groupId": "0d1fe4881dfc2b6866dbce09", "aaaManaged": true }, { "groupId": "d5cd0a60c0751a2429274933", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "dolor dolore magna in" } ], "inactive": true, "lastLogin": "1983-09-18T00:51:30.047Z", "_meta": { "created": "2015-08-30T18:18:05.95Z", "updated": "1957-02-18T19:56:36.372Z", "migrationVersion": 18340799 }, "email": "sint ea" }, "owner": { "_id": "3a9ef44f82562d0e2f8a343d", "provenance": "do mollit Excepteur", "username": "nisi Excepteur cillum", "firstname": "officia in eu enim", "memberOf": [ { "groupId": "21d4f0ec416f706a1458fcb9", "aaaManaged": false }, { "groupId": "d9219556198335168930e344", "aaaManaged": true }, { "groupId": "9f02136eb04fa39fd6f971c9", "aaaManaged": false }, { "groupId": "6362d781d2212deb473bc14e", "aaaManaged": false }, { "groupId": "3bbdb84f74d87b680a3b0e31", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "dolore" }, { "roleId": "Excepteur aliqua tempor commodo dolor" } ], "inactive": true, "lastLogin": "1949-11-23T20:24:50.384Z", "_meta": { "created": "2009-08-16T10:01:36.58Z", "updated": "1983-05-09T11:52:09.285Z", "migrationVersion": -33965707 }, "email": "incididunt minim ullamco" } } } ], "metadata": { "skip": 28930328, "limit": 10361042, "total": 18797814, "nextPageSkip": null, "previousPageSkip": null, "currentPageSize": -44850254 } }
{ "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" } } } ] }