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": 25, "skip": 0, "order": 1, "sort": "name", "include": "name,description", "exclude": "_id", "in": "est in consequat cillum adipisicing", "not-in": "nulla", "equals": "est ad", "contains": "ut et ullamco Ut veniam", "starts-with": "voluptate qui dolore sint", "ends-with": "do enim", "dereference": "mollit Ut", "gt": "ut Duis", "gte": "ad", "lt": "aliqua", "lte": "veniam aliquip magna ullamco quis", "q": "mollit", "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": "CC7e88EE-0733-0BC2-fac5-8C3D1AfDEDBd", "location": "Adapter", "view": "cillum Ut", "status": "scheduled", "app": "est elit proident id", "name": "fugiat cupidatat cillum Lorem", "variables": { "decorators": [ { "type": "encryption", "pointer": "/q+S5R/~1/~1/~1/~0/~0" }, { "type": "encryption", "pointer": "/~1/Ozib" } ] }, "last_updated": "1964-02-21T12:59:52.727Z", "encodingVersion": 1, "job": { "_id": "f307e993137fed8cf36c1131", "task": "e28f", "name": "myCoolDocumentName", "description": "Some helpful information about the document", "ancestors": [ "fd31d578fb9fb7fff7f2ee5f", "fb29044fd267d42365eaf6e8", "fa2a7aa264cd919d65b8ddd5", "9b9b5fd7e5ab814a18081c8e" ] }, "groups": [ { "_id": "59565a643a4cb42e8444f084", "provenance": "amet dolor", "name": "aliquip qui do proident ex", "description": "ut enim", "memberOf": [ { "groupId": "cf911db29e7bc015463d9a18", "aaaManaged": true }, { "groupId": "411de8ff110cbd0627877985", "aaaManaged": true }, { "groupId": "c5a20189b34b0deb9b66d8af", "aaaManaged": true }, { "groupId": "2461707ce9c3ab8c49678bd4", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "esse dolore" } ], "inactive": false, "_meta": { "created": "1998-08-09T02:42:01.687Z", "updated": "1970-11-11T05:08:02.491Z", "migrationVersion": -728873 } }, { "_id": "47ba7b3efecc4ae0cd781574", "provenance": "consequat do", "name": "in velit fugiat exercitation", "description": "qui sunt", "memberOf": [ { "groupId": "5f86d4647a016f3dd5ef53a5", "aaaManaged": true }, { "groupId": "cc3a1698cbb6f2c45813c4f7", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "veniam commodo minim quis" } ], "inactive": false, "_meta": { "created": "1981-06-13T11:12:17.515Z", "updated": "1961-03-07T12:00:46.79Z", "migrationVersion": 75537213 } }, "e2309d5e70ac19b5c8bbb93c", { "_id": "e960daf6ddc67250bd321b03", "provenance": "ut laborum fugiat nisi", "name": "ex ea et nulla", "description": "Duis", "memberOf": [ { "groupId": "5edcd6fe99a38af809dda5af", "aaaManaged": false }, { "groupId": "4be73a9cadc92a329c8ff1f1", "aaaManaged": true }, { "groupId": "4bff8e9782f5f9f34fbfbe7a", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "pariatur sit et nostrud ad" }, { "roleId": "esse culpa" } ], "inactive": false, "_meta": { "created": "2014-03-02T18:39:43.228Z", "updated": "1978-12-30T07:25:37.238Z", "migrationVersion": 30244117 } } ], "type": "manual", "metrics": { "start_time": "qui id commodo laboris", "claim_time": "1945-01-29T10:50:48.878Z", "end_time": -38556708.376296856, "server_id": "esse aliquip nisi", "finish_state": "canceled", "run_time": 29053071.927858636, "user": { "_id": "794ebc897d78858c80e61045", "provenance": "officia fugiat sint veniam", "username": "Ut dolore nostrud", "firstname": "in ut amet elit Excepteur", "memberOf": [ { "groupId": "6545e35c16658078474a8fac", "aaaManaged": false }, { "groupId": "1421771db4f169418346a6cb", "aaaManaged": false }, { "groupId": "56936974d1624978f9ff8b79", "aaaManaged": false }, { "groupId": "b16514fa8f42f7aaf2f71011", "aaaManaged": true }, { "groupId": "9192e4a32b85115147e2453e", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "reprehenderit do deserunt" } ], "inactive": false, "lastLogin": "1946-11-14T15:56:28.196Z", "_meta": { "created": "1956-08-02T19:50:28.135Z", "updated": "1949-11-05T23:15:50.866Z", "migrationVersion": -15176612 }, "email": "dolor esse anim ipsum" }, "owner": { "_id": "226a7937b8baa743c5913864", "provenance": "sint", "username": "tempor reprehenderit", "firstname": "in dolor nisi ex ut", "memberOf": [ { "groupId": "3c52421ac545ab53efc36f3c", "aaaManaged": false }, { "groupId": "77067b5fa052281d78309682", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "Duis minim sed aliquip" }, { "roleId": "voluptate irure" } ], "inactive": false, "lastLogin": "1982-06-24T19:50:09.969Z", "_meta": { "created": "1972-03-01T14:39:06.485Z", "updated": "1981-06-21T05:11:32.731Z", "migrationVersion": 6108293 }, "email": "officia" } } } ], "metadata": { "skip": -24438758, "limit": -87360958, "total": 24527024, "nextPageSkip": -34178592, "previousPageSkip": -41998150, "currentPageSize": 33970501 } }
{ "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" } } } ] }