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": 50, "order": 1, "sort": "name", "include": "name", "exclude": "_id", "in": "in dolore", "not-in": "Duis ut", "equals": "minim", "contains": "aute quis nisi", "starts-with": "do consequat Ut Lorem aliqua", "ends-with": "in", "dereference": "nisi amet Lorem", "gt": "culpa Duis laboris eu", "gte": "fugiat eu exercitation aliqua anim", "lt": "exercitation irure eiusmod consectetur", "lte": "aliquip", "q": "officia eiusmod Ut irure", "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 imported 3 of 4 documents", "data": [ { "_id": "FfBD02Ee-FB0d-f88d-8bab-c8aAc3bCA8b2", "location": "Broker", "view": null, "status": "canceled", "app": "dolor dolore occaecat non aliqua", "name": "eu", "variables": { "decorators": [ { "type": "encryption", "pointer": "/WnlP1WgU/~0/MJKYMjam/~0/~0/IveW/R+/mcGuuXZ/~0/~0/bNi39/ZE" }, { "type": "encryption", "pointer": "/~1/s/~0/~0/~0" }, { "type": "encryption", "pointer": "/~1/~1" } ] }, "last_updated": "2004-08-18T14:52:37.503Z", "encodingVersion": 1, "job": { "_id": "b6878056814c8a0a5927b367", "task": "3a1f", "name": "myCoolDocumentName", "description": "Some helpful information about the document", "ancestors": null }, "incomingRefs": [], "groups": [ { "_id": "08463dbedb201922749eaa0a", "provenance": "laborum commodo eu", "name": "Excepteur sint ad", "description": "Ut commodo amet ullamco", "memberOf": [ { "groupId": "5a295e695e5f4d5bf672ca87", "aaaManaged": true }, { "groupId": "46ba8cf8ae198a6cfb171014", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "reprehenderit commodo ut dolor" } ], "inactive": true, "_meta": { "created": "2019-10-06T01:06:19.539Z", "updated": "1957-10-21T04:32:31.184Z", "migrationVersion": -52400504 } }, { "_id": "9ce714cb7637c466799647b4", "provenance": "ut non", "name": "laborum adipisicing exercitation", "description": "irure Ut dolore est nostrud", "memberOf": [ { "groupId": "c7910591a2c8efcb4bd14767", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "adipisicing" }, { "roleId": "ut id magna" }, { "roleId": "in proident Duis Ut" } ], "inactive": true, "_meta": { "created": "1963-11-22T01:10:10.746Z", "updated": "2023-12-07T12:30:11.842Z", "migrationVersion": -58811901 } }, "492752c6c830809982444306" ], "type": "operation", "metrics": { "start_time": "sint non", "end_time": -61772.76917998493, "server_id": "dolor mollit ad", "finish_state": "success", "run_time": 66008152.255713254, "retrying": null, "user": { "_id": "7d22fbaf8c87afa20767779d", "provenance": "irure officia esse dolor proident", "username": "adipisicing incididunt", "firstname": "do magna in", "memberOf": [ { "groupId": "d5ae68bf1b225594c815aff6", "aaaManaged": true }, { "groupId": "603e56f8e9345575bd52d483", "aaaManaged": false }, { "groupId": "28bfea8b962761f66a5bbde3", "aaaManaged": false }, { "groupId": "cab5c8c58777d02999b26464", "aaaManaged": false }, { "groupId": "a112b9fb2d276c77845809d6", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "ad sed Duis" }, { "roleId": "ut amet magna" }, { "roleId": "adipisicing" } ], "inactive": false, "lastLogin": "2020-03-31T18:31:15.937Z", "_meta": { "created": "1976-04-13T04:33:36.157Z", "updated": "2018-10-23T04:11:55.272Z", "migrationVersion": -94129650 }, "email": "eu" }, "owner": { "_id": "526f575c7b92e63e1c69a32f", "provenance": "ad elit aliqua", "username": "irure", "firstname": "consectetur in Duis", "memberOf": [ { "groupId": "72193138633bef5c3f0350b8", "aaaManaged": true }, { "groupId": "a49630125aab1025a3d9eb28", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "non dolor nostrud veniam eu" }, { "roleId": "aliqua dolore quis amet tempor" }, { "roleId": "incididunt labore aute" } ], "inactive": true, "lastLogin": "1952-06-22T05:07:21.316Z", "_meta": { "created": "2000-08-03T05:35:44.1Z", "updated": "1987-11-23T15:19:07.264Z", "migrationVersion": -42379586 }, "email": "sed dolore labore" } } }, { "_id": "B9367AdA-fe6c-C20C-46c2-408f9527cece", "location": "Broker", "view": "occaecat nisi laborum voluptate", "status": "paused", "app": "ipsum", "name": "ea non culpa quis", "variables": { "decorators": [ { "type": "encryption", "pointer": "/d3ENLmgUK/~0/~0/~1/~0/ahNV+vQ/h4lkj" }, { "type": "encryption", "pointer": "/DepElx.ILU/~0" } ] }, "last_updated": "2003-09-16T11:00:46.223Z", "encodingVersion": 1, "job": { "_id": "d92214df0abef5bdb7ba3d95", "task": "e28f", "name": "myCoolDocumentName", "description": "Some helpful information about the document", "ancestors": null }, "incomingRefs": [], "groups": [ "e58a68284c5ab68f8cc07578", "ba30e7669abd8ff963f61d82", { "_id": "2da8b251cae9d5163898f597", "provenance": "elit velit", "name": "deserunt", "description": "veniam aliquip est", "memberOf": [ { "groupId": "5b280629f54ca440fdfa0e59", "aaaManaged": false }, { "groupId": "4633e05cedf6901b2605449c", "aaaManaged": false }, { "groupId": "cea04d47ae8b4f6eb2509037", "aaaManaged": true }, { "groupId": "1d19cdbf61fef4edc8563f72", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "nostrud" }, { "roleId": "non et esse veniam dolore" } ], "inactive": false, "_meta": { "created": "1984-02-09T07:41:32.215Z", "updated": "1989-08-05T01:52:45.425Z", "migrationVersion": 18923060 } }, { "_id": "21a784c3a2086b2f56c938dd", "provenance": "aliqua", "name": "eiusmod pariatur quis occaecat ad", "description": "pariatur", "memberOf": [ { "groupId": "111572f70f4be2d8341f44d8", "aaaManaged": true }, { "groupId": "0a2119e3ad9d1331003ccaba", "aaaManaged": false }, { "groupId": "b33460a9711c3bd93ed0bc04", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "sunt veniam incididunt proident" }, { "roleId": "ex eiusmod magna aliquip" } ], "inactive": true, "_meta": { "created": "1952-08-30T09:18:08.881Z", "updated": "1955-02-14T21:55:37.507Z", "migrationVersion": 26402416 } }, "4feea66c6aa13bdea1aa1849" ], "type": "operation", "metrics": { "start_time": "ut nisi irure", "end_time": 47086882.33611539, "server_id": "eu in", "finish_state": "success", "run_time": 55103531.46410245, "retrying": null, "user": "", "owner": "9fe6c9e637dfe643ee31402f" } } ], "metadata": { "skip": -49966235, "limit": -9925548, "total": 77170377, "nextPageSkip": null, "previousPageSkip": null, "currentPageSize": 59439152 } }
{ "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" } } } ] }