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": 1, "skip": 1, "order": 1, "sort": "name", "include": "description", "exclude": "description", "in": "quis proident", "not-in": "velit anim in non enim", "equals": "occaecat nostrud eu ullamco voluptate", "contains": "laborum pariatur deserunt fugiat dolore", "starts-with": "dolor", "ends-with": "laborum Excepteur dolor adipisicing", "dereference": "dolor cupidatat eu", "gt": "non", "gte": "nisi magna", "lt": "nostrud quis aliqua veniam magna", "lte": "sunt eiusmod esse amet occaecat", "q": "aute proident Excepteur", "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": "95f5D44a-22d0-f395-AC9C-ac075AaBbAbD", "location": "Broker", "view": null, "status": "incomplete", "app": "labore", "name": "magna culpa", "variables": { "decorators": [ { "type": "encryption", "pointer": "/rpR4.,t+j/F4G/EXsI1.Jf/~1" }, { "type": "encryption", "pointer": "/FugQg/GsNqC5/~0/~1" }, { "type": "encryption", "pointer": "/h/~0/rb33+V1l-Q/c0vfTZ/~1/DQv8tJj" } ] }, "last_updated": "2024-03-20T17:35:51.468Z", "encodingVersion": 1, "job": { "_id": "869fbd5cbc049736b68bf861", "task": "e28f", "name": "myCoolDocumentName", "description": "Some helpful information about the document", "ancestors": [ "f48e4aa080f31399da343cf3", "d26af453103d581432646947" ] }, "groups": [ "bfd7112560d0a921485d2b44", { "_id": "3e996b3a31d2e5888554dee8", "provenance": "nostrud Duis culpa", "name": "nulla", "description": "in sit minim do", "memberOf": [ { "groupId": "fb58a9076113b8a27ee7b48f", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "in ad" }, { "roleId": "nisi sint anim" }, { "roleId": "Excepteur laborum exercitation" }, { "roleId": "reprehenderit labore minim" }, { "roleId": "laborum" } ], "inactive": false, "_meta": { "created": "2003-09-04T11:55:54.712Z", "updated": "1946-12-21T22:31:42.885Z", "migrationVersion": 89033526 } }, { "_id": "021954e7f989f5c8dfde4a25", "provenance": "velit", "name": "voluptate incididunt officia cillum", "description": "in dolor occaecat aliqua", "memberOf": [ { "groupId": "af19a7b4e52eeffe5e8fc7ee", "aaaManaged": false }, { "groupId": "e59d80fb3979bad3a99b8283", "aaaManaged": true }, { "groupId": "400ba3f22a68db183f2fc04d", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "nisi anim" }, { "roleId": "aliqua consequat reprehenderit in adipisicing" }, { "roleId": "consequat ullamco commodo exercitation" }, { "roleId": "anim ullamco" }, { "roleId": "aliquip pariatur Lorem" } ], "inactive": true, "_meta": { "created": "1960-11-15T06:12:11.037Z", "updated": "1956-07-15T06:51:35.514Z", "migrationVersion": 53139989 } } ], "type": "operation", "metrics": { "start_time": "aute consectetur aliqua sed", "end_time": -22943313.09573035, "server_id": "consequat irure anim", "finish_state": "success", "run_time": 45886310.72745487, "retrying": false, "user": "", "owner": { "_id": "9a4f62fe32f16252af1ef9ef", "provenance": "aliqua eiusmod reprehenderit occaecat", "username": "labore anim", "firstname": "dolor Duis fugiat deserunt", "memberOf": [ { "groupId": "aec3b8e3056f86e53ec3716f", "aaaManaged": true }, { "groupId": "3943f5df2e47fe92411b42ec", "aaaManaged": true }, { "groupId": "3f4bde7fddd131734d0abc24", "aaaManaged": false }, { "groupId": "a49fdbc0f22df8adbbfc6fb4", "aaaManaged": false }, { "groupId": "9c9021bd9b496b8ee9e071c1", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "fugiat" } ], "inactive": false, "lastLogin": "1974-06-16T01:54:33.29Z", "_meta": { "created": "2006-08-31T07:01:03.76Z", "updated": "1994-08-21T03:30:46.407Z", "migrationVersion": -88139896 }, "email": "in elit ut aliquip anim" } } }, { "_id": "EdB6894e-dfdD-608e-Ff90-23B808B3E37B", "location": "Adapter", "view": null, "status": "scheduled", "app": "aliquip occaecat commodo", "name": "tempor", "variables": { "decorators": [ { "type": "encryption", "pointer": "/~0/O/VSe/rXb5rdi0/~1/~0" }, { "type": "encryption", "pointer": "/~0/~1/~1" }, { "type": "encryption", "pointer": "/~0/~0/it3/I0wZMDQ/~0/~0/~0/vEf/~0" }, { "type": "encryption", "pointer": "/~0/~0/KfA-MQj9Z3/dO3M/~0/DBnf40jsh/~1" } ] }, "last_updated": "2005-11-06T05:29:53.298Z", "encodingVersion": 1, "job": { "_id": "908fbeaf8bfb0ce7af955964", "task": "e28f", "name": "myCoolDocumentName", "description": "Some helpful information about the document", "ancestors": null }, "groups": [ "cd53de96d4a6adf22406cf1a", "45de061e335786b366949b8b", { "_id": "4686d02ef577b7a79ba0787e", "provenance": "laborum Excepteur elit ex", "name": "reprehenderit nisi tempor sit commodo", "description": "ut aute reprehenderit consequat", "memberOf": [ { "groupId": "928468a7aaf49031b349f2fd", "aaaManaged": false }, { "groupId": "e0b6d5e6f4b9d37a75cd388f", "aaaManaged": true }, { "groupId": "9213289bd02d55a08f8fb0b1", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "do esse commodo" }, { "roleId": "adipisicing et nostrud" }, { "roleId": "officia laborum do elit" }, { "roleId": "adipisicing nostrud" }, { "roleId": "officia Lorem ex dolor Ut" } ], "inactive": false, "_meta": { "created": "1987-11-25T09:31:39.749Z", "updated": "2020-07-01T06:28:19.722Z", "migrationVersion": -63922489 } }, "ad9f339830a386ae62c6f352", { "_id": "b99b5c28e3e9247b60afe0e5", "provenance": "laborum", "name": "ullamco", "description": "veniam", "memberOf": [ { "groupId": "7f361924e1136944eb9877ab", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "fugiat in dolor" }, { "roleId": "in eu ipsum" }, { "roleId": "sint deserunt Ut officia pariatur" }, { "roleId": "aliquip aliqua do" } ], "inactive": false, "_meta": { "created": "1953-03-29T15:04:05.372Z", "updated": "2010-05-06T10:39:48.161Z", "migrationVersion": -10755003 } } ], "type": "operation", "metrics": { "start_time": "officia occaecat ex Duis anim", "end_time": 16634103.138276532, "server_id": "Lorem sint reprehenderit cupidatat aliqua", "finish_state": "success", "run_time": 53571564.529678494, "retrying": null, "user": "3b88c3dc7d2642228ea26a6d", "owner": "Pronghorn" } } ], "metadata": { "skip": -74594898, "limit": 97745086, "total": 39821700, "nextPageSkip": 2585903, "previousPageSkip": -33275779, "currentPageSize": 7638818 } }
{ "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" } } } ] }