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": 10, "order": 1, "sort": "name", "include": "name", "exclude": "_id,description", "in": "ut anim dolor", "not-in": "ex dolor sint eu consectetur", "equals": "do enim", "contains": "et dolor anim ullamco", "starts-with": "fugiat veniam occaecat sit", "ends-with": "occaecat sit", "dereference": "eu aliquip", "gt": "occaecat commodo labore exercitation", "gte": "in consectetur pariatur mollit Duis", "lt": "laborum dolor enim eiusmod tempor", "lte": "nisi Ut", "q": "est", "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": "22D9EF92-6fdF-aDEd-02D4-93CBC0Fb8b94", "location": "Application", "view": "magna cillum aliquip deserunt", "status": "running", "app": "incididunt", "name": "laborum", "variables": { "decorators": [ { "type": "encryption", "pointer": "/sqR/iYaVVKg/C./~0/~0" }, { "type": "encryption", "pointer": "/FOteN8UWe3/bA-AX6q9M5S/~1/~0/AyC/Z7mpjYsA.yM/F5OYDt/wD8q7SkAEx/~0" }, { "type": "encryption", "pointer": "/v/~1/~1/bm/~1/S07InXS" }, { "type": "encryption", "pointer": "/t/~0/Vsh0RA7SB" } ] }, "last_updated": "1991-10-12T03:40:26.228Z", "encodingVersion": 1, "job": { "_id": "4fbc42f8f41adb05ce3d68dc", "task": "b4f", "name": "myCoolDocumentName", "description": "Some helpful information about the document", "ancestors": [ "56758f3c188e8ee4f52ea4e3", "07a9e11d853d0b39c218283c", "6d7d55dd4342a9215c2676a4", "e8f4e8a211d6952e7cc3fda3", "48d17225fa8709639e873550" ] }, "incomingRefs": [], "groups": [ { "_id": "6d2d3f86ec4a3fcaa96dcc3a", "provenance": "dolor nostrud est", "name": "nisi", "description": "sed ullamco", "memberOf": [ { "groupId": "19a5109c8e52e280b784b873", "aaaManaged": true }, { "groupId": "d92ca1e5ab37ff510228fb8f", "aaaManaged": false }, { "groupId": "fb244be2230abc41ef285f64", "aaaManaged": true }, { "groupId": "f4f8278c3e48eca9cd38ea6e", "aaaManaged": true }, { "groupId": "275ba44c0d8aa7544f4cd34a", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "aliquip labore" }, { "roleId": "velit nisi magna dolore" }, { "roleId": "tempor" }, { "roleId": "officia" }, { "roleId": "Duis Ut in minim" } ], "inactive": true, "_meta": { "created": "1986-06-05T01:01:27.925Z", "updated": "2004-03-30T17:16:38.88Z", "migrationVersion": 92345007 } }, { "_id": "67abfd4e216f2e66047df3b0", "provenance": "nulla adipisicing sed officia", "name": "adipisicing dolor", "description": "anim", "memberOf": [ { "groupId": "e1d975305be343ead4acc477", "aaaManaged": true }, { "groupId": "3cef3bddc09971ef0c2561da", "aaaManaged": true }, { "groupId": "dd9b99da05410056615167da", "aaaManaged": false }, { "groupId": "c00158c330126823ad486d5e", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "in dolor" } ], "inactive": true, "_meta": { "created": "1971-04-04T11:29:17.36Z", "updated": "2016-11-12T01:28:29.629Z", "migrationVersion": 93344344 } } ], "type": "automatic", "metrics": { "start_time": "occaecat sunt aute", "end_time": -75393032.70485681, "server_id": "ipsum dolor Ut", "finish_state": "success", "run_time": -57013791.256208576, "retrying": false, "user": { "_id": "6c28a918534eb7709f3c4ee9", "provenance": "sed dolor nostrud pariatur", "username": "cupidatat dolore esse", "firstname": "ut eu est et", "memberOf": [ { "groupId": "e1d0275023785c9804bceb6e", "aaaManaged": true }, { "groupId": "c306ec46ed8acfe3230481fc", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "consequat" } ], "inactive": false, "lastLogin": "1967-03-07T18:19:00.906Z", "_meta": { "created": "1971-12-21T23:49:28.179Z", "updated": "1980-06-24T01:18:48.249Z", "migrationVersion": 25519711 }, "email": "qui sint" }, "owner": { "_id": "702622dd6873cc73c56f083f", "provenance": "dolor", "username": "Ut est ea", "firstname": "proident exercitation consequat dolor Lorem", "memberOf": [ { "groupId": "3ebee13cd54beac763e3d684", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "sint officia in" }, { "roleId": "aute magna labore laborum consequat" } ], "inactive": false, "lastLogin": "2012-05-16T21:57:16.481Z", "_meta": { "created": "1979-07-03T04:49:55.14Z", "updated": "1952-09-25T15:01:31.613Z", "migrationVersion": 7668154 }, "email": "occaecat id est dolor" } } }, { "_id": "258F1Dd3-7395-5d5d-5daC-2C0A53aFd0FB", "location": "Application", "view": "sint in", "status": "incomplete", "app": "do", "name": "minim", "variables": { "decorators": [ { "type": "encryption", "pointer": "/~1/~1/WIN+1Fq/l0lkguNmx/CZGEr/INbD/~1/EIW.Q/plj//~1/~0" }, { "type": "encryption", "pointer": "/U3WFXyFXHaz/~0/E8z/cTqF/k/~0/SJ-GAdc/n/~1/~0/ksLT" }, { "type": "encryption", "pointer": "/Rf/RIegJ/z0YA/wiA4R4Rek-U/~1/~0/Gd/Zg4/wDV6n0p0/l3i/~0" }, { "type": "encryption", "pointer": "/bWoG/~0/~1/nvOm7Rm/~1/BuQ/~0/V" } ] }, "last_updated": "1996-03-09T00:04:17.443Z", "encodingVersion": 1, "job": { "_id": "8b854a0e4f9a95c82ee37aeb", "task": "e28f", "name": "myCoolDocumentName", "description": "Some helpful information about the document", "ancestors": [ "f4df3ed93446554db2ab2331", "dee830d6638d8ab37705627c", "640baf3ffb2aef3b73df53c9" ] }, "incomingRefs": [], "groups": [ { "_id": "e0ab3e80866dd071f64a0668", "provenance": "et in anim fugiat sint", "name": "voluptate elit proident", "description": "dolor voluptate laboris aliqua veniam", "memberOf": [ { "groupId": "d2b8fa48556aa027f2801826", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "quis ex" }, { "roleId": "laborum exercitation" }, { "roleId": "Duis" }, { "roleId": "dolor" }, { "roleId": "Duis nulla anim" } ], "inactive": false, "_meta": { "created": "1978-04-15T13:41:40.107Z", "updated": "1997-12-27T08:21:37.07Z", "migrationVersion": 84619537 } }, { "_id": "c345c5dee45218b35174707d", "provenance": "in", "name": "amet laborum dolor cillum voluptate", "description": "in do", "memberOf": [ { "groupId": "a84fcb3fb911136af4454257", "aaaManaged": true }, { "groupId": "c92da4caef025371ecce26c9", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "voluptate adipisicing dolor in consequat" }, { "roleId": "cillum ex Ut elit" }, { "roleId": "Ut sint" } ], "inactive": false, "_meta": { "created": "1989-11-01T22:07:33.805Z", "updated": "1992-11-28T12:31:57.061Z", "migrationVersion": -46708687 } }, { "_id": "1bef847797469e44085ad0e7", "provenance": "aute non mollit nisi", "name": "exercitation ipsum ullamco", "description": "tempor pariatur ex est Lorem", "memberOf": [ { "groupId": "6b00ca982a3facc9b4d8553d", "aaaManaged": false }, { "groupId": "8bede5053c9ec399481ca056", "aaaManaged": true }, { "groupId": "0cb3057f93828f827c309b89", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "irure exercitation non labore" }, { "roleId": "occaecat nisi eiusmod" }, { "roleId": "aute deserunt" }, { "roleId": "anim" } ], "inactive": false, "_meta": { "created": "2011-10-16T16:31:58.096Z", "updated": "1959-04-01T23:12:50.632Z", "migrationVersion": -19416555 } }, "72fbe8ed15be8be700f2980b" ], "type": "automatic", "metrics": { "start_time": "officia consequat ea laborum", "end_time": -17383588.80651249, "server_id": "commodo", "finish_state": "complete", "run_time": -17451115.97037217, "retrying": null, "user": "23c2de696b8098e8db8230ea", "owner": "Pronghorn" } } ], "metadata": { "skip": 61879754, "limit": -74422833, "total": -14647296, "nextPageSkip": -52394957, "previousPageSkip": 41088701, "currentPageSize": -69124351 } }
{ "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" } } } ] }