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": 0, "order": 1, "sort": "name", "include": "name", "exclude": "_id,description", "in": "Excepteur", "not-in": "dolor Excepteur incididunt", "equals": "dolor cupidatat", "contains": "in sit", "starts-with": "sint Excepteur id aliquip", "ends-with": "pariatur dolor dolor aliquip sint", "dereference": "irure Lorem", "gt": "aliqua Lorem ex cupidatat", "gte": "nostrud mollit Duis ullamco proident", "lt": "labore", "lte": "eiusmod exercitation quis tempor laborum", "q": "sunt 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 retrieved search results", "data": [ { "_id": "c4f57fFF-d2FF-5aaB-7A5c-E787afef79E2", "location": "Broker", "view": "nostrud reprehenderit eiusmod in aliquip", "status": "scheduled", "app": "aliquip", "name": "elit", "variables": { "decorators": [ { "type": "encryption", "pointer": "/~0" }, { "type": "encryption", "pointer": "/Wz/i4-AQE80/~1/AZBJ/v3c8V+/fL+PUHz/v/eKdPkP5FZe/bsZ-8OI/YCDs6HC+/dMq/q" }, { "type": "encryption", "pointer": "/TY9GEv5q-/VJU/W/~0/tk,75/~1/zkazpP," }, { "type": "encryption", "pointer": "/~0/~0/~0/lFDIKi" } ] }, "last_updated": "1973-05-06T16:40:48.496Z", "encodingVersion": 1, "job": { "_id": "7d9591026b287792c99c5d5d", "task": "b4f", "name": "myCoolDocumentName", "description": "Some helpful information about the document", "ancestors": [ "1a8aa218775064bbc57f6e3e", "830b3423c4d2e75c63ab76a3", "98a6f75b00807a7d30944eec", "8c1ba85444f611b34ebe3c3c" ] }, "incomingRefs": [], "groups": [ "66df1d94157931cda29e4e75", { "_id": "b248bb32e6c3775abe7eb450", "provenance": "Ut do in", "name": "incididunt nulla sit proident", "description": "in labore non", "memberOf": [ { "groupId": "e3ccaa3232f9b15524207149", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "reprehenderit quis dolor ex" }, { "roleId": "commodo laboris dolore pariatur occaecat" }, { "roleId": "Lorem aute" } ], "inactive": false, "_meta": { "created": "1979-05-22T05:26:15.402Z", "updated": "1944-05-07T02:52:09.022Z", "migrationVersion": 59890000 } } ], "type": "manual", "metrics": { "start_time": "dolore tempor", "claim_time": "1945-12-28T23:31:51.128Z", "end_time": 90206705.18554771, "server_id": "fugiat Ut aliqua sunt occaecat", "finish_state": "incomplete", "run_time": -50693583.14684296, "user": "", "owner": "Pronghorn" } }, { "_id": "0216EC84-aAC0-6D61-098a-aC066cBceD05", "location": "Application", "view": "consectetur in pariatur aute nisi", "status": "incomplete", "app": "dolore Excepteur ullamco", "name": "Ut sit dolor adipisicing", "variables": { "decorators": [ { "type": "encryption", "pointer": "/Za/VAf7v/AMf/~1/o+uDAHS/TPh5,5" }, { "type": "encryption", "pointer": "/~0/k0e,EQ/Xsk/v.qtk/~1/~1/yBC+6n/TvxJZb43" }, { "type": "encryption", "pointer": "/~0/~0/~1/qzV" } ] }, "last_updated": "2014-05-10T01:22:43.903Z", "encodingVersion": 1, "job": { "_id": "3039d97f8675d1f300986fda", "task": "e28f", "name": "myCoolDocumentName", "description": "Some helpful information about the document", "ancestors": null }, "incomingRefs": [], "groups": [ { "_id": "b33615bdd3a9386ff2fbd027", "provenance": "laboris sunt ipsum Lorem reprehenderit", "name": "reprehenderit magna dolore non ut", "description": "elit ut aute", "memberOf": [ { "groupId": "f4cde98f085f36062fa3828a", "aaaManaged": false }, { "groupId": "3ef15af4cc5600321c4e0226", "aaaManaged": false }, { "groupId": "70cda5cce6ddc6ca94dd3604", "aaaManaged": false }, { "groupId": "9064d5f78a66006606e2cb2a", "aaaManaged": true }, { "groupId": "97974e279c16817acc483971", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "aute sed" } ], "inactive": false, "_meta": { "created": "1995-09-20T18:39:01.747Z", "updated": "1997-12-12T08:30:47.088Z", "migrationVersion": -17828556 } }, "a3ff1ff24d88d97c050862ea", "9f414fad86f806962df758e1" ], "type": "manual", "metrics": { "start_time": "ad", "claim_time": "1992-10-20T12:03:19.555Z", "end_time": 64221440.054436386, "server_id": "voluptate minim non nisi", "finish_state": "scheduled", "run_time": -22217723.004114106, "user": "", "owner": { "_id": "aea2dcba5246b66ed9af1ed6", "provenance": "amet anim", "username": "do aute", "firstname": "ullamco", "memberOf": [ { "groupId": "2a16946a94947ae4d256b9a8", "aaaManaged": false }, { "groupId": "19422780cb329ac324b6d339", "aaaManaged": false }, { "groupId": "4289bf9847b098a9d9eb7057", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "exercitation anim id" }, { "roleId": "dolor voluptate est tempor qui" } ], "inactive": true, "lastLogin": "2007-05-02T20:19:39.165Z", "_meta": { "created": "1995-10-28T03:16:41.989Z", "updated": "1989-03-04T10:32:33.537Z", "migrationVersion": 68268377 }, "email": "anim dolor" } } }, { "_id": "a5Da8C3b-66De-DeD1-caC1-feC990fCa89A", "location": "Application", "view": null, "status": "error", "app": "adipisicing Lorem ea amet Excepteur", "name": "dolor ullamco ipsum pariatur", "variables": { "decorators": [ { "type": "encryption", "pointer": "/Gt/~0/GKfjBrh/v0/~0/~0" }, { "type": "encryption", "pointer": "/~0/W/pBFP0DWFdTu/hFWv/~0/C/T0TtrDweSp-" } ] }, "last_updated": "1950-05-29T12:39:11.086Z", "encodingVersion": 1, "job": { "_id": "5660f5c99322fe4ddd5423d6", "task": "b4f", "name": "myCoolDocumentName", "description": "Some helpful information about the document", "ancestors": null }, "incomingRefs": [], "groups": [ { "_id": "bc9080decde6c2e55685b52d", "provenance": "anim occaecat", "name": "officia Lorem anim minim veniam", "description": "minim ut eiusmod", "memberOf": [ { "groupId": "698fa4de31403f67d294d934", "aaaManaged": false }, { "groupId": "3bf94543f39b8b7077fb3fe3", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "ea sit adipisicing" } ], "inactive": false, "_meta": { "created": "1961-02-25T22:24:59.437Z", "updated": "1991-11-13T03:45:20.049Z", "migrationVersion": 4308129 } }, "4a64bcb7bff018e65f43637b", "93817261195fb1bdc4494155" ], "type": "manual", "metrics": { "start_time": "sed aute", "claim_time": "2023-04-03T04:39:27.035Z", "end_time": 80326906.23916388, "server_id": "ut Lorem eiusmod officia", "finish_state": "complete", "run_time": -14109750.399966717, "user": { "_id": "9763f1c01180d1eabb072138", "provenance": "pariatur exercitation Excepteur est", "username": "pariatur deserunt reprehenderit", "firstname": "sit ullamco", "memberOf": [ { "groupId": "3f02b11d1ce21ed353f24af2", "aaaManaged": true }, { "groupId": "4030fdd0dc77002f12a7d20f", "aaaManaged": false }, { "groupId": "3b82dccff681c6c6de03a9c1", "aaaManaged": false }, { "groupId": "eeee2461186956e71c11e343", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "pariatur sed tempor Excepteur nulla" }, { "roleId": "sunt sit laboris minim veniam" } ], "inactive": false, "lastLogin": "1958-03-21T12:31:45.874Z", "_meta": { "created": "1998-03-22T08:05:32.123Z", "updated": "2023-09-04T02:32:07.676Z", "migrationVersion": 96497100 }, "email": "esse ex irure Lorem dolor" }, "owner": "Pronghorn" } } ], "metadata": { "skip": 42568641, "limit": 81944528, "total": 61635128, "nextPageSkip": null, "previousPageSkip": null, "currentPageSize": -44662085 } }
{ "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" } } } ] }