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": 1, "skip": 50, "order": 1, "sort": "name", "include": "name,description", "exclude": "description", "in": "id", "not-in": "deserunt aliquip irure velit", "equals": "proident fugiat enim", "contains": "deserunt minim nulla nostrud pariatur", "starts-with": "elit sunt in", "ends-with": "commodo ut occaecat anim", "dereference": "minim magna est", "gt": "sunt anim nostrud ut", "gte": "velit", "lt": "ut sit pariatur laboris laborum", "lte": "ut eu", "q": "nulla", "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": "6bCB9e8d-dB9E-eEC0-c6A0-B5ACA6e17e7e", "location": "Application", "view": "laborum", "status": "incomplete", "app": "in est ullamco id exercitation", "name": "voluptate nulla non sint", "variables": { "decorators": [ { "type": "encryption", "pointer": "/KNc8l0/~0/~0/VgUGz/~0/Mi6nI.Pq/~0/p949JOjV" }, { "type": "encryption", "pointer": "/EFyLYBCYdtO" }, { "type": "encryption", "pointer": "/yICP8CH,z/~0/~1/~1/~0" }, { "type": "encryption", "pointer": "/~1" } ] }, "last_updated": "1966-12-14T03:49:54.234Z", "encodingVersion": 1, "job": { "_id": "6f46d14c417d648a1050144a", "task": "3a1f", "name": "myCoolDocumentName", "description": "Some helpful information about the document", "ancestors": [ "5d9e6576a6dcb546f3479e72", "87109417601ae07919ea9d51", "1b1e51b14be8de868921472c" ] }, "groups": [ { "_id": "1e828fe4a8e33663c7094065", "provenance": "in ex", "name": "fugiat amet quis proident qui", "description": "dolore Excepteur", "memberOf": [ { "groupId": "4097fc658995b3286506dfb6", "aaaManaged": true }, { "groupId": "7cbe8838e8b0819c11eafb11", "aaaManaged": true }, { "groupId": "07205d23687aec750fe55029", "aaaManaged": false }, { "groupId": "e7fe453ba7871d7527a873b9", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "sed" }, { "roleId": "consectetur id Excepteur dolor Duis" }, { "roleId": "ut fugiat ullamco dolore" }, { "roleId": "laborum aliquip" } ], "inactive": true, "_meta": { "created": "1991-07-22T04:17:06.912Z", "updated": "2013-03-16T21:12:27.04Z", "migrationVersion": 5429895 } }, "591f58bacc760e0822e05c1c", "68d5b01dc61d87d845c5a649", { "_id": "cf5c61b62be8e12be3a8af77", "provenance": "culpa aliqua sunt deserunt", "name": "exercitation", "description": "quis eu consectetur", "memberOf": [ { "groupId": "0e1ccd5c616062eb238108cc", "aaaManaged": false }, { "groupId": "226f485c5c2dab914e4afc7a", "aaaManaged": false }, { "groupId": "65c19295d05d9300f2eee3e0", "aaaManaged": false }, { "groupId": "bbd3576ac154545321e418f4", "aaaManaged": false }, { "groupId": "f581056d69034f9998507622", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "proident" }, { "roleId": "dolore sit aliqua quis veniam" }, { "roleId": "culpa consequat" } ], "inactive": true, "_meta": { "created": "1965-02-18T23:29:49.041Z", "updated": "1983-02-06T23:27:57.404Z", "migrationVersion": -69827017 } }, "361bb7bd56e02643eff9e5a6" ], "type": "operation", "metrics": { "start_time": "amet irure Lorem", "end_time": 3753683.4384287745, "server_id": "tempor fugiat ullamco", "finish_state": "success", "run_time": 56612798.64915216, "retrying": null, "user": { "_id": "4b0bee46988861185c16997d", "provenance": "incididunt ex ut elit", "username": "pariatur", "firstname": "nisi ut occaecat aliquip Ut", "memberOf": [ { "groupId": "5a3b96c4d3361d09965c3631", "aaaManaged": true }, { "groupId": "4e7a2b63f2965efd87d53d01", "aaaManaged": false }, { "groupId": "1605722cc2e2cddb39b0df3b", "aaaManaged": false }, { "groupId": "7cfa63a7044e1b0e29635c0a", "aaaManaged": false }, { "groupId": "656fdd11a56111fb10aadd19", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "Ut mollit" }, { "roleId": "sint fugiat deserunt" }, { "roleId": "deserunt exercitation ad" } ], "inactive": false, "lastLogin": "2015-12-24T17:07:26.897Z", "_meta": { "created": "1953-11-17T12:55:28.667Z", "updated": "1980-12-18T11:08:08.747Z", "migrationVersion": 90536733 }, "email": "nisi ut elit laboris nulla" }, "owner": "" } } ], "metadata": { "skip": -71838113, "limit": -14891557, "total": 29942855, "nextPageSkip": null, "previousPageSkip": null, "currentPageSize": -11021861 } }
{ "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" } } } ] }