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": 1, "order": 1, "sort": "name", "include": "name", "exclude": "_id", "in": "laboris", "not-in": "minim pariatur dolore", "equals": "veniam in", "contains": "magna dolore cupidatat occaecat ea", "starts-with": "elit", "ends-with": "laborum occaecat velit officia Lorem", "dereference": "consectetur eiusmod ex ipsum", "gt": "in deserunt dolor", "gte": "eu reprehenderit in", "lt": "aliqua dolore", "lte": "sunt commodo", "q": "ea labore occaecat sint proident", "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": "5403E7C0-d45B-f3A9-A4E4-2a3B6db3165d", "location": "Adapter", "view": "sed adipisicing aliqua reprehenderit", "status": "complete", "app": "labore commodo et aliquip", "name": "Ut Excepteur laboris in sint", "variables": { "decorators": [ { "type": "encryption", "pointer": "/XZiGPmIK/UJ/nhBOeaMFg/D/~1" }, { "type": "encryption", "pointer": "/GjG0tap/~0/~0/gWLhDmENvbB/~0/~1/~0/~0/nqkvB/~1" }, { "type": "encryption", "pointer": "/~1/JpUl2,kd/l2/wBzYg0yC/~1/~0/JcDMfpT/~0" }, { "type": "encryption", "pointer": "/zVUTIaXSiKU/uEvd/~1/~0/ySy9/a2aHQ/b" }, { "type": "encryption", "pointer": "/f-OiRHo/~1/IUQy4Ua1fJ5/ia/x+/~1" } ] }, "last_updated": "2023-09-22T03:27:56.633Z", "encodingVersion": 1, "job": { "_id": "f35a53591d0119c14eec4086", "task": "b4f", "name": "myCoolDocumentName", "description": "Some helpful information about the document", "ancestors": [ "aaec560274be36966375d258", "b35fb8bf9e6fa4bad152584c" ] }, "groups": [ { "_id": "29f6ccc9ee7f5b6ced9889e6", "provenance": "ipsum minim cillum aliquip", "name": "consectetur ullamco pariatur laborum nostrud", "description": "nisi sit ipsum", "memberOf": [ { "groupId": "24d0809ba2586432f9d8c4dd", "aaaManaged": false }, { "groupId": "764a61a237bf4022dd569883", "aaaManaged": true }, { "groupId": "ad5ccdc6cbae251cf802a63f", "aaaManaged": false }, { "groupId": "165b423510220074f11ee327", "aaaManaged": false }, { "groupId": "3e0461b351228ac50eac68a6", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "do ullamco" }, { "roleId": "deserunt ut et ea" }, { "roleId": "eiusmod sunt laboris quis aute" } ], "inactive": false, "_meta": { "created": "1981-11-06T19:32:02.761Z", "updated": "2018-05-29T23:13:11.295Z", "migrationVersion": -77126776 } }, "8e8d1d79f1d8c0848c9ca002", "db8c98a6c12a881fb030d197", "5a49b08f548053ec4dbf3247" ], "type": "manual", "metrics": { "start_time": "aliqua eu Lorem consectetur", "claim_time": "1996-09-08T13:49:02.856Z", "end_time": 22916368.254670605, "server_id": "tempor consequat incididunt pariatur in", "finish_state": "canceled", "run_time": 65539004.88166341, "user": "c50e7ae94495a82a1d0be374", "owner": { "_id": "67f91d9f9b9407b00bb2de3e", "provenance": "deserunt nisi veniam labore", "username": "laborum", "firstname": "exercitation id Ut eu adipisicing", "memberOf": [ { "groupId": "43394bed8b2485c09c618286", "aaaManaged": true }, { "groupId": "efff40fb82019a1368deffdd", "aaaManaged": false }, { "groupId": "51d1e0abc2916626b38cfc31", "aaaManaged": false }, { "groupId": "2d6ae455f07c967499e9ac4a", "aaaManaged": false }, { "groupId": "ca5dd20fa24ea349e14bdd6c", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "do" }, { "roleId": "proident Lorem" }, { "roleId": "non velit anim et tempor" }, { "roleId": "ipsum aute" } ], "inactive": false, "lastLogin": "2006-12-23T03:26:59.949Z", "_meta": { "created": "1958-04-24T01:29:56.869Z", "updated": "1967-09-23T11:55:48.548Z", "migrationVersion": 41659050 }, "email": "est culpa" } } }, { "_id": "4BedC195-cfFA-0A1A-5bBC-D321A08F2f20", "location": "Application", "view": "minim commodo aliquip adipisicing", "status": "scheduled", "app": "sed occaecat sint consectetur", "name": "voluptate ea eiusmod", "variables": { "decorators": [ { "type": "encryption", "pointer": "/~1/~0/kkw2q7j./lH/wq/A635UX39YL+/~1/~0" }, { "type": "encryption", "pointer": "/~1/~0/VAduf/l-.WPRscp/~1/~1/W7aeRol//~0" } ] }, "last_updated": "1971-03-11T06:54:06.538Z", "encodingVersion": 1, "job": { "_id": "500ee76135104ee673ddad62", "task": "e28f", "name": "myCoolDocumentName", "description": "Some helpful information about the document", "ancestors": null }, "groups": [ { "_id": "5eaa9bc74c78a0db465cd6e4", "provenance": "irure minim veniam consequat est", "name": "irure amet", "description": "qui reprehenderit culpa aute", "memberOf": [ { "groupId": "9c6db288f3b6d4bfbbd96e0a", "aaaManaged": true }, { "groupId": "f2b70cbe7f3f831718dd6cf3", "aaaManaged": true }, { "groupId": "09ac1b1246677767a11e3f37", "aaaManaged": true }, { "groupId": "87fd9ad3fde6f4a373099f77", "aaaManaged": false }, { "groupId": "04a4b546fa65041e857eb2fd", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "incididunt" }, { "roleId": "eu sed" }, { "roleId": "dolor ut nostrud" }, { "roleId": "ea labore laborum" }, { "roleId": "aliquip Ut minim" } ], "inactive": true, "_meta": { "created": "1955-09-13T07:48:15.26Z", "updated": "2000-09-26T02:54:41.313Z", "migrationVersion": 36617906 } }, "5f2df5e0e23001e6832eb425", { "_id": "b7c99f38f5fbabb8f2a0836c", "provenance": "sunt", "name": "deserunt fugiat laborum sint", "description": "dolor velit Duis", "memberOf": [ { "groupId": "f62b2f201874518189d4292f", "aaaManaged": true }, { "groupId": "f44d88c92529087fc522171c", "aaaManaged": true }, { "groupId": "57dd142abffcc3bd44aa35a9", "aaaManaged": false }, { "groupId": "ecfacec99627a79b4db03ec5", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "ut eiusmod voluptate magna enim" }, { "roleId": "Duis" }, { "roleId": "et adipisicing occaecat" }, { "roleId": "cupidatat aliqua" }, { "roleId": "in incididunt consectetur" } ], "inactive": false, "_meta": { "created": "2025-05-18T04:21:58.698Z", "updated": "1997-07-21T14:44:01.715Z", "migrationVersion": -71154433 } }, "32e6743ccb0a274ca6b284bd", "12d799b89e452565481dd9e4" ], "type": "manual", "metrics": { "start_time": "sunt aliqua aute sit laboris", "claim_time": "1960-07-10T06:06:44.927Z", "end_time": 27510885.64665447, "server_id": "occaecat", "finish_state": "success", "run_time": 98030039.7282587, "user": { "_id": "872ae07465fdd80f24f8ddde", "provenance": "in ad pariatur dolore eu", "username": "incididunt pariatur consectetur in ullamco", "firstname": "ullamco adipisicing", "memberOf": [ { "groupId": "be86cab9945d0c31d8e3fee1", "aaaManaged": true }, { "groupId": "6c9dadb6245f7dc0cbebc975", "aaaManaged": true }, { "groupId": "24d8d86d1bfc3ac2a239c94b", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "ea quis pariatur est cillum" }, { "roleId": "Excepteur" }, { "roleId": "Lorem Duis nostrud ad" } ], "inactive": true, "lastLogin": "1962-01-04T01:45:05.328Z", "_meta": { "created": "1998-04-01T16:42:08.787Z", "updated": "2022-05-14T11:06:50.687Z", "migrationVersion": 45054938 }, "email": "laborum ut ad irure culpa" }, "owner": "fce10d8c9a31fcab5ed0726a" } }, { "_id": "3b21af9a-0d5F-fCC3-9f2a-57b27b7daaC1", "location": "Broker", "view": "reprehenderit velit ea", "status": "scheduled", "app": "tempor", "name": "esse non", "variables": { "decorators": [ { "type": "encryption", "pointer": "/~1/~1/~0/~0" }, { "type": "encryption", "pointer": "/~0/Pd696HCX1/OJQ1o/~0/mq/o60Ow9pJGL/Nz" }, { "type": "encryption", "pointer": "/llERuMC/~1/~1/NN21u/~0/~1/~0/LFHOGvM/~1/jk.J3dOGeZ" }, { "type": "encryption", "pointer": "/~0/KUY/bUR/PZN5h5765/H,/KTVb5wOk/Xbx77hkAd/~0/IJS6wKW6RXZ/Z4p" }, { "type": "encryption", "pointer": "/~1/~1/rwZKvcGnh/~1/mD/c7CNxIX.5oU/~1" } ] }, "last_updated": "1968-05-11T20:01:56.939Z", "encodingVersion": 1, "job": { "_id": "89be437fc6ad6c86e990ba4e", "task": "b4f", "name": "myCoolDocumentName", "description": "Some helpful information about the document", "ancestors": null }, "groups": [ { "_id": "7c74e1bd8d94b3a0f7c08cae", "provenance": "et Ut occaecat", "name": "cupidatat mollit irure amet", "description": "in incididunt aute adipisicing mollit", "memberOf": [ { "groupId": "749edf92802827fd251632f0", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "ut eu" } ], "inactive": false, "_meta": { "created": "1989-08-06T12:51:21.991Z", "updated": "1984-01-02T01:02:28.423Z", "migrationVersion": 77225451 } } ], "type": "manual", "metrics": { "start_time": "magna cupidatat consequat", "claim_time": "1952-06-27T00:11:00.766Z", "end_time": -78351501.9707849, "server_id": "aliqua id", "finish_state": "complete", "run_time": -39344133.062821254, "user": "9641c20cdc707a3679ae326c", "owner": { "_id": "e9ed153e858cddf90f263abd", "provenance": "mollit voluptate", "username": "fugiat deserunt qui in proident", "firstname": "ea tempor mollit irure", "memberOf": [ { "groupId": "da9f02efcad21d3b8314c86b", "aaaManaged": true }, { "groupId": "fa2ff5f64bc52c37719fddde", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "quis sunt dolore Lorem" }, { "roleId": "labore anim laborum reprehenderit minim" }, { "roleId": "ut" }, { "roleId": "esse est eiusmod" } ], "inactive": false, "lastLogin": "2019-01-16T01:22:56.058Z", "_meta": { "created": "2022-09-02T16:38:46.777Z", "updated": "2013-06-22T12:09:58.313Z", "migrationVersion": -20992643 }, "email": "mollit ut" } } } ], "metadata": { "skip": 91050551, "limit": -54492565, "total": 9410744, "nextPageSkip": null, "previousPageSkip": 12239061, "currentPageSize": 55121491 } }
{ "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" } } } ] }