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": 0, "order": 1, "sort": "name", "include": "name,description", "exclude": "_id,description", "in": "exercitation fugiat non eiusmod ea", "not-in": "proident laborum", "equals": "consectetur enim velit mollit", "contains": "ipsum dolor Excepteur", "starts-with": "dolore in", "ends-with": "ex reprehenderit", "dereference": "et", "gt": "anim reprehenderit nulla elit Lorem", "gte": "tempor nostrud", "lt": "in commodo officia", "lte": "dolore", "q": "laborum sint ipsum nisi", "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": "f75b4Bba-80a6-c21f-4F3B-Ecd6b1789E2b", "location": "Application", "view": null, "status": "canceled", "app": "elit pariatur dolor", "name": "ullamco dolore occaecat ex enim", "variables": { "decorators": [ { "type": "encryption", "pointer": "/~1/~0/qM/Yi1,/~0/fZr/~0/~0/m5AM" }, { "type": "encryption", "pointer": "/~1" } ] }, "last_updated": "2011-11-15T02:40:21.726Z", "encodingVersion": 1, "job": { "_id": "e905bec6d6d79ef3044fe14d", "task": "e28f", "name": "myCoolDocumentName", "description": "Some helpful information about the document", "ancestors": null }, "incomingRefs": [], "groups": [ "4ede2790d4a87d7b863001a0" ], "type": "automatic", "metrics": { "start_time": "ex labore", "end_time": -3766842.7364674807, "server_id": "culpa esse", "finish_state": "scheduled", "run_time": 34529887.21381131, "retrying": true, "user": { "_id": "db2851053fe0483f11c12b5b", "provenance": "Duis", "username": "id aliqua", "firstname": "exercitation Lorem nostrud consequat", "memberOf": [ { "groupId": "ab862a090eb13d90a9b79d3c", "aaaManaged": false }, { "groupId": "875e95b94289f4b8b2a6f988", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "in eu dolor Duis dolore" }, { "roleId": "dolor sunt deserunt" }, { "roleId": "est non reprehenderit dolore" }, { "roleId": "incididunt mollit occaecat" }, { "roleId": "aliquip id" } ], "inactive": false, "lastLogin": "1967-03-15T12:19:02.059Z", "_meta": { "created": "2001-06-10T12:13:43.317Z", "updated": "1985-10-31T05:17:13.682Z", "migrationVersion": -68652701 }, "email": "in voluptate dolor" }, "owner": "b25704eab97cb2b96a49a178" } }, { "_id": "8365CF11-b4cb-6Ca8-cC03-AdE0B8D3eeE6", "location": "Application", "view": "adipisicing ut non ut", "status": "incomplete", "app": "non ipsum voluptate dolore", "name": "pariatur et ullamco", "variables": { "decorators": [ { "type": "encryption", "pointer": "/~1/~0/~0/v.a/ZcKKN/~1" } ] }, "last_updated": "2014-01-24T11:05:25.181Z", "encodingVersion": 1, "job": { "_id": "06c9ff0b7512824e7bb8dd47", "task": "3a1f", "name": "myCoolDocumentName", "description": "Some helpful information about the document", "ancestors": null }, "incomingRefs": [], "groups": [ { "_id": "b44733674333f15a1b9a42f5", "provenance": "irure ex anim Duis magna", "name": "cupidatat laboris adipisicing aliqua sit", "description": "ut in", "memberOf": [ { "groupId": "1de7401ea8a1bc41af4e2a1e", "aaaManaged": true }, { "groupId": "50c6700a553f91072813458a", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "eiusmod nulla ex Excepteur aliquip" }, { "roleId": "non occaecat commodo exercitation" } ], "inactive": true, "_meta": { "created": "2000-11-14T22:44:26.862Z", "updated": "1968-02-20T21:50:58.682Z", "migrationVersion": -26634337 } } ], "type": "automatic", "metrics": { "start_time": "eu tempor Excepteur sed nulla", "end_time": -32607741.97251916, "server_id": "Duis adipisicing est", "finish_state": "error", "run_time": 83202008.63858464, "retrying": true, "user": "66c1b5a51cfd0b878f6ce668", "owner": { "_id": "ca68dc244bd48695712a9fe2", "provenance": "ut tempor minim aliquip anim", "username": "tempor incididunt deserunt occaecat", "firstname": "Excepteur id qui occaecat enim", "memberOf": [ { "groupId": "5325e1c52c7a8eebf1cde53b", "aaaManaged": false }, { "groupId": "98ab4d828eb5e5c61dcd28e4", "aaaManaged": true }, { "groupId": "35b38da298ca8e64700880da", "aaaManaged": false }, { "groupId": "00d7f44896dd17139cd7069c", "aaaManaged": true }, { "groupId": "818e1f229d6265909fd7d0cc", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "laboris consectetur ullamco" }, { "roleId": "exercitation adipisicing ullamco commodo" } ], "inactive": false, "lastLogin": "1961-08-01T06:07:56.951Z", "_meta": { "created": "1954-02-06T02:31:03.883Z", "updated": "1982-12-29T17:35:17.393Z", "migrationVersion": 43079379 }, "email": "qui voluptate" } } }, { "_id": "1245EbeD-2569-B068-bFB2-CCB42B97f959", "location": "Adapter", "view": null, "status": "failure", "app": "magna ad Ut quis", "name": "ut occaecat amet sint", "variables": { "decorators": [ { "type": "encryption", "pointer": "/~0/~0/~0/kxMc/~0" }, { "type": "encryption", "pointer": "/FQ1yK6" }, { "type": "encryption", "pointer": "/~0/~0" }, { "type": "encryption", "pointer": "/~0/b85IsCDS/~1/~0" } ] }, "last_updated": "2019-01-19T13:16:00.658Z", "encodingVersion": 1, "job": { "_id": "d05b3c2738980944bd7efb2c", "task": "b4f", "name": "myCoolDocumentName", "description": "Some helpful information about the document", "ancestors": null }, "incomingRefs": [], "groups": [ { "_id": "6f0d81c7ce150befdf07e84b", "provenance": "Ut", "name": "est deserunt aute velit", "description": "velit ex", "memberOf": [ { "groupId": "46872e102fd9a4037f1b4415", "aaaManaged": false }, { "groupId": "cf74b1b368c8a364230100db", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "pariatur sunt adipisicing culpa commodo" }, { "roleId": "ad nulla" }, { "roleId": "magna in tempor eu anim" }, { "roleId": "nostrud sunt aliqua sint incididunt" } ], "inactive": true, "_meta": { "created": "1998-01-25T08:14:36.121Z", "updated": "1960-01-19T07:19:15.726Z", "migrationVersion": -60089013 } }, { "_id": "332dd3492c7003192fbf5035", "provenance": "labore reprehenderit Ut aliquip in", "name": "commodo fugiat ad", "description": "consectetur in non", "memberOf": [ { "groupId": "3df6cfa98e2d7478453f6b0d", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "dolor" }, { "roleId": "irure adipisicing" }, { "roleId": "dolor deserunt irure voluptate sit" }, { "roleId": "proident culpa in" }, { "roleId": "eiusmod minim qui culpa" } ], "inactive": true, "_meta": { "created": "1974-03-15T12:45:35.524Z", "updated": "1967-01-06T01:03:32.074Z", "migrationVersion": -93245931 } }, "e96a9ce12172661f1cac1941", { "_id": "30cfa0f937fe78fb2d96a43b", "provenance": "voluptate ad nulla Duis Ut", "name": "ea ipsum cillum ad", "description": "enim consequat nisi cupidatat", "memberOf": [ { "groupId": "acb91cf0ca3087ab8e80b9ed", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "ullamco officia eu nulla sunt" }, { "roleId": "in" }, { "roleId": "deserunt tempor consequat" }, { "roleId": "eu" } ], "inactive": false, "_meta": { "created": "2021-05-04T08:20:10.908Z", "updated": "2002-09-17T02:02:39.569Z", "migrationVersion": -49399927 } } ], "type": "automatic", "metrics": { "start_time": "nostrud Lorem est officia", "end_time": -83290629.60225281, "server_id": "et in sint", "finish_state": "scheduled", "run_time": 98466426.39627147, "retrying": false, "user": "Pronghorn", "owner": "Pronghorn" } } ], "metadata": { "skip": -69562000, "limit": -9096834, "total": 26537266, "nextPageSkip": null, "previousPageSkip": -97311678, "currentPageSize": 7455939 } }
{ "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" } } } ] }