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,description", "exclude": "_id", "in": "esse voluptate", "not-in": "irure tempor magna", "equals": "ullamco laboris elit sit cillum", "contains": "sit", "starts-with": "sint", "ends-with": "officia eu", "dereference": "fugiat incididunt in", "gt": "aliquip anim", "gte": "veniam Ut", "lt": "eiusmod enim ad", "lte": "qui dolore ea", "q": "dolore Duis magna", "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": "2Ea89cC7-02EF-bD4A-D6Dc-31AAFF3e0AD5", "location": "Adapter", "view": "Ut Duis mollit", "status": "complete", "app": "qui proident incididunt voluptate Lorem", "name": "sed consequat voluptate", "variables": { "decorators": [ { "type": "encryption", "pointer": "/hZgAXAJLi" }, { "type": "encryption", "pointer": "/Ca/~0/~0/~0/~0/AlJv1Jd/C+pjx" }, { "type": "encryption", "pointer": "/LlRsvJJ/cQpeFlbToY/Rj8X,/~1/~0/A5vXzM.M-AS/jGB/~1" }, { "type": "encryption", "pointer": "/oUl/C/~1/~0/kau" } ] }, "last_updated": "1954-06-16T18:16:10.497Z", "encodingVersion": 1, "job": { "_id": "44f7a07c5a8862bd33306443", "task": "b4f", "name": "myCoolDocumentName", "description": "Some helpful information about the document", "ancestors": [ "10ae9b4c2956a9d3af5f376a" ] }, "incomingRefs": [], "groups": [ "f99a7ebe71a4f0fb571f8ed4" ], "type": "operation", "metrics": { "start_time": "laborum", "end_time": -58462224.08672128, "server_id": "irure", "finish_state": "incomplete", "run_time": 6934797.350239694, "retrying": null, "user": { "_id": "53f076c830fc116a56ddc4ba", "provenance": "esse anim Ut", "username": "enim sunt dolore", "firstname": "quis voluptate et culpa", "memberOf": [ { "groupId": "9af1b1259d0b50b21a27591d", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "ullamco labore dolor cillum" } ], "inactive": true, "lastLogin": "1970-06-21T08:28:22.449Z", "_meta": { "created": "2001-01-30T03:31:19.52Z", "updated": "1989-01-15T10:29:24.773Z", "migrationVersion": 82558448 }, "email": "proident velit occaecat aliqua" }, "owner": "d125d5a9116693f4f1535e66" } }, { "_id": "6D01dBa9-03AF-e59d-34EB-e622FFeae484", "location": "Broker", "view": "in proident", "status": "canceled", "app": "tempor laboris", "name": "officia in culpa aute", "variables": { "decorators": [ { "type": "encryption", "pointer": "/~1/~0/~1/~1" }, { "type": "encryption", "pointer": "/~1/V9.dArRs/Kciue/~0/zs2uSCiIE/~1/EhD/Hu0o-8DBg/y" }, { "type": "encryption", "pointer": "/eW/Xxvu/~1/~0/JXRLxiP3-O/~1/~1/o" } ] }, "last_updated": "1997-01-03T07:09:41.658Z", "encodingVersion": 1, "job": { "_id": "c792e6a7c7b337b8f4c1f7ae", "task": "e28f", "name": "myCoolDocumentName", "description": "Some helpful information about the document", "ancestors": [ "9bbc5f20f6703e27a36a8e5e", "fff08a062d70ea0592570df0" ] }, "incomingRefs": [], "groups": [ { "_id": "fee6c4011c0171a74a4662c2", "provenance": "sint proident fugiat", "name": "non aliquip esse veniam", "description": "dolore magna incididunt dolore in", "memberOf": [ { "groupId": "aa6aa81f8bcb2e672b785dc2", "aaaManaged": false }, { "groupId": "5efbe5b6197c5ce711496120", "aaaManaged": true }, { "groupId": "53f2921ae1d7c093651a4774", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "et ullamco" } ], "inactive": true, "_meta": { "created": "1952-07-20T14:35:04.112Z", "updated": "2014-03-16T07:03:28.186Z", "migrationVersion": 98629592 } }, { "_id": "108200fe1c851cfeb375eb5e", "provenance": "culpa dolor", "name": "eiusmod occaecat nulla aliquip", "description": "mollit velit amet sunt ullamco", "memberOf": [ { "groupId": "2c3eda36449fb024580f2be8", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "qui" }, { "roleId": "exercitation nisi voluptate quis" }, { "roleId": "ipsum laboris Lorem sunt do" } ], "inactive": true, "_meta": { "created": "1951-08-08T17:51:09.965Z", "updated": "1985-03-27T16:51:19.914Z", "migrationVersion": 63685770 } }, { "_id": "91f6c30ed983bd88e09c3502", "provenance": "ut", "name": "consequat", "description": "esse consectetur ad", "memberOf": [ { "groupId": "5ed3ff87f37dd7649000a3aa", "aaaManaged": false }, { "groupId": "380870d133730a0f6f5433e2", "aaaManaged": false }, { "groupId": "921c06508de5c4bb86969b93", "aaaManaged": false }, { "groupId": "e99ff0e1cb85337a67ac30ff", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "irure" }, { "roleId": "eiusmod dolor enim aute" } ], "inactive": true, "_meta": { "created": "1976-12-09T22:35:15.091Z", "updated": "2013-07-10T22:59:12.18Z", "migrationVersion": 73548813 } }, "5d7b1f71f58ce19e3f5c3ede", "a52ced824a948431ee13a897" ], "type": "operation", "metrics": { "start_time": "in fugiat consequat", "end_time": 16496667.596611708, "server_id": "veniam qui reprehenderit Ut", "finish_state": "success", "run_time": 18509198.813025802, "retrying": null, "user": "60364d5060f08cddc09cf3bc", "owner": "27ca88c27ef776d6b3a90255" } }, { "_id": "7aA20Ae3-9C50-d534-7A4D-8e6C92C66130", "location": "Adapter", "view": "eu sunt incididunt", "status": "incomplete", "app": "cupidatat magna in quis", "name": "mollit elit aute fugiat ut", "variables": { "decorators": [ { "type": "encryption", "pointer": "/R/TanYB/~0/~1/~1/~0/~1/ukAknQ8/~0/~1" }, { "type": "encryption", "pointer": "/~0/~1/qMamWwQ/6b/~1/D.uf//~1" }, { "type": "encryption", "pointer": "/~1/~0/P/~0/~0/JFq" } ] }, "last_updated": "1992-04-15T19:03:03.759Z", "encodingVersion": 1, "job": { "_id": "19cefc0f651c34387bfa5352", "task": "b4f", "name": "myCoolDocumentName", "description": "Some helpful information about the document", "ancestors": [ "550ae0d8e64ebdbb8d892b73", "e3b9e529730f8173b2b45654", "52e7840aa8935cc1adc68c78", "c4a9ce26587e2926616dadcf" ] }, "incomingRefs": [], "groups": [ { "_id": "543c0292252f8ad1eaf3dcf4", "provenance": "sint fugiat ex Lorem", "name": "dolor non dolor ullamco", "description": "ut ullamco mollit", "memberOf": [ { "groupId": "9ef2442f98b335c1ef505fe9", "aaaManaged": true }, { "groupId": "4a8143dc119a97dc6bd2c7ba", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "dolore" }, { "roleId": "ex" }, { "roleId": "est" } ], "inactive": false, "_meta": { "created": "1956-08-24T09:50:05.443Z", "updated": "1988-12-09T12:04:34.511Z", "migrationVersion": -80019152 } } ], "type": "operation", "metrics": { "start_time": "ea aliquip", "end_time": 66593909.26109409, "server_id": "nulla voluptate mollit ea", "finish_state": "success", "run_time": -38538371.708006956, "retrying": true, "user": { "_id": "b4d86d1369d36b8c0824fdaf", "provenance": "elit qui non in", "username": "cupidatat officia laboris", "firstname": "nisi aliqua", "memberOf": [ { "groupId": "4d23367ca701317da1e0a957", "aaaManaged": false }, { "groupId": "ac4f3c966de148d749dcf84b", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "veniam amet aute" }, { "roleId": "culpa consectetur in sit" }, { "roleId": "eu Ut officia fugiat" }, { "roleId": "nostrud eiusmod ad quis" }, { "roleId": "enim laboris culpa" } ], "inactive": false, "lastLogin": "1987-02-25T16:28:53.867Z", "_meta": { "created": "1957-10-08T16:16:22.118Z", "updated": "1992-07-22T09:53:34.872Z", "migrationVersion": 84478339 }, "email": "irure" }, "owner": "10aef8bed9420635681fb663" } } ], "metadata": { "skip": -92933681, "limit": 6967595, "total": 85604511, "nextPageSkip": null, "previousPageSkip": 73412311, "currentPageSize": -18422217 } }
{ "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" } } } ] }