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": 50, "skip": 0, "order": 1, "sort": "name", "include": "name", "exclude": "_id,description", "in": "deserunt", "not-in": "magna minim dolor nisi", "equals": "adipisicing dolor et reprehenderit", "contains": "aute", "starts-with": "in voluptate nulla", "ends-with": "reprehenderit labore occaecat sunt laborum", "dereference": "pariatur Excepteur reprehenderit", "gt": "culpa ullamco", "gte": "do velit id", "lt": "aliquip laborum minim cupidatat anim", "lte": "ea amet ex eiusmod", "q": "consequat culpa nulla in", "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": "E87C7CE7-ad95-56Aa-0b94-8F078e724cC0", "location": "Adapter", "view": null, "status": "complete", "app": "consequat commodo", "name": "laboris sed fugiat", "variables": { "decorators": [ { "type": "encryption", "pointer": "/PWqFgxG" }, { "type": "encryption", "pointer": "/Jqc-EnzFD1O/mdgO/k/s/x8pKGWx/sBRe,Mx/~0/ddzN6wDV/e2-ZX9Cpx6P/~1/~1" }, { "type": "encryption", "pointer": "/~1/~0" }, { "type": "encryption", "pointer": "/~1/~1/~1/~1/~1/~1/Hcu4dNG/~1" } ] }, "last_updated": "1976-01-13T14:11:25.902Z", "encodingVersion": 1, "job": { "_id": "a9c369afcb1c08a880508cba", "task": "b4f", "name": "myCoolDocumentName", "description": "Some helpful information about the document", "ancestors": [ "5fd7d4d1b826df233488c265", "646e48b64c90afda60e131f2", "210b9df821c96618a43dff53", "64729e527fef10bea293d56a", "061304b4fdc7f169ec67a718" ] }, "incomingRefs": [], "groups": [ "059e65449d9d08c684be33b7" ], "type": "manual", "metrics": { "start_time": "adipisicing minim sunt sint", "claim_time": "2003-09-18T03:22:18.687Z", "end_time": 39272463.18572083, "server_id": "proident in officia esse", "finish_state": "complete", "run_time": 75199151.47724742, "user": { "_id": "437fd3305dfb55c920880ac4", "provenance": "proident in sed", "username": "laboris", "firstname": "dolore amet sit", "memberOf": [ { "groupId": "71c3a55f871d9aeb746f9379", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "ea elit officia eu" } ], "inactive": true, "lastLogin": "1991-01-24T01:32:25.779Z", "_meta": { "created": "2013-02-05T23:47:44.646Z", "updated": "1977-11-07T11:55:26.15Z", "migrationVersion": 16608451 }, "email": "aute ut" }, "owner": "1b3e7de779473308362f5ddd" } } ], "metadata": { "skip": 79480761, "limit": -36043470, "total": 62917838, "nextPageSkip": 965319, "previousPageSkip": -8020458, "currentPageSize": -20905595 } }
{ "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" } } } ] }