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": "description", "exclude": "description", "in": "consequat Ut magna laborum nulla", "not-in": "exercitation", "equals": "eiusmod aliquip", "contains": "ut", "starts-with": "exercitation nostrud dolor in", "ends-with": "consequat adipisicing cupidatat officia occaecat", "dereference": "sit commodo officia", "gt": "laborum cupidatat dolor", "gte": "nisi ullamco esse sint", "lt": "cupidatat ipsum", "lte": "ea", "q": "aute dolore dolor irure commodo", "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": "eFEe3a3F-D7ab-4Ba2-cCDD-b1cc9DaFf939", "location": "Broker", "view": "exercitation dolore elit", "status": "incomplete", "app": "ullamco", "name": "Lorem ad ut nostrud mollit", "variables": { "decorators": [ { "type": "encryption", "pointer": "/~0/x8BFR/LqGRhpSaD/~0/TX2/~0/~1" }, { "type": "encryption", "pointer": "/fJ/~1" } ] }, "last_updated": "1951-06-16T00:15:47.016Z", "encodingVersion": 1, "job": { "_id": "f9427af27e8bf0098dd18b39", "task": "3a1f", "name": "myCoolDocumentName", "description": "Some helpful information about the document", "ancestors": null }, "incomingRefs": [], "groups": [ { "_id": "1eee8e49d7075e199bb35707", "provenance": "fugiat labore cillum voluptate", "name": "sunt incididunt fugiat reprehenderit sint", "description": "elit labore", "memberOf": [ { "groupId": "642aff1933c5550cff4ef6e7", "aaaManaged": false }, { "groupId": "4be1b99d349e953a8154630a", "aaaManaged": true }, { "groupId": "3ebc5838eaf14e6750266863", "aaaManaged": true }, { "groupId": "e95fa8d12826628c9a0a79e5", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "eiusmod velit" }, { "roleId": "sed dolor reprehenderit in" }, { "roleId": "est ipsum dolore" } ], "inactive": false, "_meta": { "created": "1950-11-24T19:44:18.349Z", "updated": "1949-01-28T08:49:42.808Z", "migrationVersion": 49153491 } }, { "_id": "f41b8d1b1a543b903827c55f", "provenance": "ut", "name": "Ut ex eiusmod", "description": "laborum officia", "memberOf": [ { "groupId": "c091647c4d0cc584610c5ad6", "aaaManaged": true }, { "groupId": "e093205d0d6180144fb32115", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "aute" }, { "roleId": "ut Excepteur ullamco est" }, { "roleId": "esse exercitation labore id non" }, { "roleId": "reprehenderit occaecat" }, { "roleId": "id pariatur laborum" } ], "inactive": false, "_meta": { "created": "1966-09-25T00:05:36.529Z", "updated": "2022-04-09T15:30:10.411Z", "migrationVersion": -43412925 } } ], "type": "manual", "metrics": { "start_time": "proident Ut minim adipisicing", "claim_time": "2016-10-12T10:11:14.17Z", "end_time": 32514491.505353898, "server_id": "culpa aute commodo labore reprehenderit", "finish_state": "success", "run_time": 64558565.201616615, "user": { "_id": "0d02b091101dcb61384e5ab2", "provenance": "sed occaecat incididunt mollit", "username": "laborum nulla cillum veniam mollit", "firstname": "amet laboris quis occaecat adipisicing", "memberOf": [ { "groupId": "d604169598b1b60bbe8a1476", "aaaManaged": false }, { "groupId": "9ea9f5669d5dc72c55a32d70", "aaaManaged": false }, { "groupId": "d5cc4a0913cfd0c21a05867f", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "enim reprehenderit" } ], "inactive": false, "lastLogin": "1989-07-08T03:28:46.325Z", "_meta": { "created": "2022-01-20T08:25:19.039Z", "updated": "1953-03-18T23:58:03.494Z", "migrationVersion": 66788382 }, "email": "ipsum reprehenderit irure" }, "owner": { "_id": "5463b75e26582d105c8e1317", "provenance": "consectetur cupidatat mollit tempor", "username": "anim tempor cupidatat", "firstname": "fugiat proident do est in", "memberOf": [ { "groupId": "e05401957c38c99392096cb2", "aaaManaged": false }, { "groupId": "ef4d113a1dc1d327c25e2148", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "in nisi" }, { "roleId": "veniam aliqua eu officia commodo" }, { "roleId": "nulla incididunt Duis pariatur Excepteur" } ], "inactive": true, "lastLogin": "1985-08-11T05:21:12.932Z", "_meta": { "created": "1963-07-13T13:52:25.244Z", "updated": "1973-01-29T23:11:10.621Z", "migrationVersion": 24402124 }, "email": "proident et amet aliqua" } } } ], "metadata": { "skip": 79465094, "limit": 60416415, "total": 5629811, "nextPageSkip": null, "previousPageSkip": -12496690, "currentPageSize": -10433070 } }
{ "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" } } } ] }