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": "_id", "in": "ad in", "not-in": "est officia incididunt laboris sint", "equals": "ex deserunt sint ea", "contains": "dolor", "starts-with": "Ut incididunt qui anim", "ends-with": "sed minim cillum exercitation enim", "dereference": "do", "gt": "ad in", "gte": "tempor occaecat Excepteur voluptate dolore", "lt": "Ut Duis quis dolor commodo", "lte": "aliquip cillum labore culpa", "q": "anim velit sunt", "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": "9A5eDbe2-C2A4-4901-1fCa-ab4F1E8a6c0F", "location": "Application", "view": "ut elit ullamco sunt cillum", "status": "canceled", "app": "culpa est", "name": "veniam sint esse dolor", "variables": { "decorators": [ { "type": "encryption", "pointer": "/~0/~0/~1/Bm6o7JWQ/ZWq06gpq/~1" }, { "type": "encryption", "pointer": "/AC6py85/~1/QoHo/L0zveh" }, { "type": "encryption", "pointer": "/vl-giY/qf2h/a/~1" }, { "type": "encryption", "pointer": "/GExD.fzv,/~1/~1/Bl5zuzgztY/~1/~1/N7jw.W31OKZ/ETI/sEHbw3MGz/~1" } ] }, "last_updated": "1985-12-30T19:08:30.431Z", "encodingVersion": 1, "job": { "_id": "2020d97fb86c0b5cb264d3b8", "task": "e28f", "name": "myCoolDocumentName", "description": "Some helpful information about the document", "ancestors": null }, "incomingRefs": [], "groups": [ "8f29ff5ceb1d5b44c9633a51", "77cb7716fad431b8c6d2cd9c" ], "type": "automatic", "metrics": { "start_time": "labore cillum exercitation amet Ut", "end_time": -77860870.8214226, "server_id": "dolor mollit irure Ut officia", "finish_state": "paused", "run_time": 10485760.718272626, "retrying": null, "user": { "_id": "d270bb6f077ab6283e8084a3", "provenance": "amet", "username": "esse eiusmod", "firstname": "aliquip ad", "memberOf": [ { "groupId": "62b0518fca8c0a7eb1efc4fd", "aaaManaged": true }, { "groupId": "d859357066fffd1fe1ddc133", "aaaManaged": false }, { "groupId": "b122b961702d0b8ca49ba93b", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "tempor ex anim nulla" }, { "roleId": "sit sint" } ], "inactive": false, "lastLogin": "2005-02-11T08:48:38.089Z", "_meta": { "created": "1991-04-01T20:49:18.134Z", "updated": "1955-12-10T08:20:31.846Z", "migrationVersion": 39318347 }, "email": "aliquip laboris" }, "owner": { "_id": "614abf34f1ff12479b6ba060", "provenance": "occaecat adipisicing sunt sint commodo", "username": "dolore", "firstname": "ex reprehenderit dolore occaecat", "memberOf": [ { "groupId": "afb7608730dd04752b8bedb1", "aaaManaged": true }, { "groupId": "248933e4e532b11643270869", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "pariatur id occaecat dolor" }, { "roleId": "in deserunt dolor proident commodo" }, { "roleId": "cupidatat quis" }, { "roleId": "culpa" }, { "roleId": "reprehenderit dolore occaecat sint ullamco" } ], "inactive": true, "lastLogin": "1966-10-18T12:33:11.964Z", "_meta": { "created": "1987-04-05T19:37:56.703Z", "updated": "2021-01-12T03:51:41.458Z", "migrationVersion": -67702889 }, "email": "sed dolore Excepteur tempor minim" } } }, { "_id": "cef40FB9-9abD-624a-227D-3bDA045D9fD2", "location": "Adapter", "view": null, "status": "error", "app": "eu in culpa", "name": "amet nisi et", "variables": { "decorators": [ { "type": "encryption", "pointer": "/Af/BXk2k/j0Xo/c/8K/~1/Xk5s0ea+Pgs/rb/djNrkqv/Pxk/ve5DWp5/~0" }, { "type": "encryption", "pointer": "/~0/~1/~1/~0" }, { "type": "encryption", "pointer": "/~1/~1/stFKja" } ] }, "last_updated": "1986-02-07T00:22:21.12Z", "encodingVersion": 1, "job": { "_id": "61e1f12670402095c8223a0d", "task": "3a1f", "name": "myCoolDocumentName", "description": "Some helpful information about the document", "ancestors": null }, "incomingRefs": [], "groups": [ "6415758dde44dc0f30df8216" ], "type": "automatic", "metrics": { "start_time": "aliqua sed", "end_time": 54605657.69463068, "server_id": "nulla ullamco esse", "finish_state": "failure", "run_time": 22289175.544488862, "retrying": null, "user": "", "owner": "Pronghorn" } } ], "metadata": { "skip": 97412387, "limit": -41859157, "total": 32875040, "nextPageSkip": null, "previousPageSkip": 54875241, "currentPageSize": -39095296 } }
{ "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" } } } ] }