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": "name", "exclude": "_id,description", "in": "dolore enim", "not-in": "aliquip voluptate Ut", "equals": "proident cupidatat dolor do", "contains": "aliqua id", "starts-with": "consectetur", "ends-with": "laboris nostrud et est", "dereference": "ut aute est", "gt": "non eu aliquip", "gte": "et labore ex esse", "lt": "in", "lte": "commodo Ut", "q": "ipsum", "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": "b5ec1F6c-Ffff-E66D-1DbC-b490F0f4f92E", "location": "Adapter", "view": "eiusmod in elit nisi", "status": "canceled", "app": "sunt non fugiat", "name": "officia consequat elit sint voluptate", "variables": { "decorators": [ { "type": "encryption", "pointer": "/~0/WEA/~0/C/x/~1" }, { "type": "encryption", "pointer": "/eSHD4ok/~0/t9+n/~1/zKCh/~1/~1/~1/Q201PAh/uKGTuUD9i/pvd.d8" }, { "type": "encryption", "pointer": "/hR2nJK77/~1/~0/~1" }, { "type": "encryption", "pointer": "/~1/~1/uuG8shu0S/~0" } ] }, "last_updated": "1998-01-05T11:23:40.659Z", "encodingVersion": 1, "job": { "_id": "078e3143000d4b822c1e238e", "task": "b4f", "name": "myCoolDocumentName", "description": "Some helpful information about the document", "ancestors": [ "c3da1c2449281a1257f8fc49", "e11c7a322d4d25c0ea316db0", "5cc5ee67e48b2f23ba445fba" ] }, "groups": [ { "_id": "b1a54aa62fa32b3a215b5a96", "provenance": "tempor aute nostrud amet", "name": "amet dolor", "description": "do qui in culpa", "memberOf": [ { "groupId": "8eaadc34b762ec70ea177590", "aaaManaged": true }, { "groupId": "8a5a17383d69aa9fefcc79fe", "aaaManaged": false }, { "groupId": "189f4c125f99ba81db3798aa", "aaaManaged": true }, { "groupId": "d55f3543f3cb5c8449aa9267", "aaaManaged": true }, { "groupId": "daff7e519ecb1bd79d964c69", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "laborum cillum exercitation sint minim" } ], "inactive": false, "_meta": { "created": "1992-02-01T01:23:32.882Z", "updated": "1968-02-22T02:41:44.818Z", "migrationVersion": 52988651 } }, { "_id": "ee8419d4e05baa5ec2c1c5da", "provenance": "sint", "name": "adipisicing occaecat", "description": "non ad aliqua pariatur", "memberOf": [ { "groupId": "ca2ef9276b11320b27eccb69", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "amet proident eiusmod do" } ], "inactive": false, "_meta": { "created": "2012-11-11T03:42:48.731Z", "updated": "1968-05-09T11:40:17.038Z", "migrationVersion": 43045906 } }, "9cca448c93a965f88e6a0c0d", "e7b8e7702c02880f6c2f7c87", { "_id": "46a561037f855c783e70f062", "provenance": "Lorem aliquip veniam", "name": "Duis voluptate", "description": "in irure laboris", "memberOf": [ { "groupId": "ba286d65de31d59211e2c01b", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "esse ipsum pariatur" }, { "roleId": "dolor elit laboris in eu" } ], "inactive": false, "_meta": { "created": "1964-12-04T01:03:05.783Z", "updated": "1961-02-21T16:13:46.313Z", "migrationVersion": 35313979 } } ], "type": "automatic", "metrics": { "start_time": "ea", "end_time": 68667920.75390315, "server_id": "proident elit ex Excepteur", "finish_state": "success", "run_time": -66198299.757859, "retrying": false, "user": "", "owner": "Pronghorn" } } ], "metadata": { "skip": -2566817, "limit": -51206278, "total": -49008036, "nextPageSkip": null, "previousPageSkip": null, "currentPageSize": -93990726 } }
{ "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" } } } ] }