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": 10, "skip": 1, "order": 1, "sort": "name", "include": "name", "exclude": "description", "in": "proident", "not-in": "veniam nostrud aliquip cupidatat et", "equals": "non Lorem cillum ad", "contains": "officia sunt nisi Lorem consequat", "starts-with": "ex aliquip id aliqua dolore", "ends-with": "consectetur Duis", "dereference": "eiusmod laborum ut", "gt": "dolore", "gte": "Ut voluptate", "lt": "in est", "lte": "Duis", "q": "pariatur", "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": "B7dD596C-8CF6-3dfC-cAC0-1F4DD8b046FD", "location": "Application", "view": "eu velit magna", "status": "scheduled", "app": "minim Duis sint eu cillum", "name": "Ut dolor ullamco", "variables": { "decorators": [ { "type": "encryption", "pointer": "/K" }, { "type": "encryption", "pointer": "/M/~0" }, { "type": "encryption", "pointer": "/~1/~1/~1" }, { "type": "encryption", "pointer": "/p" }, { "type": "encryption", "pointer": "/BV/Xi2pLcLiJ/~0/~1/~1/Er1mSlR/~0" } ] }, "last_updated": "1960-03-10T19:44:18.399Z", "encodingVersion": 1, "job": { "_id": "7f4151dc434387d4c5ddda39", "task": "b4f", "name": "myCoolDocumentName", "description": "Some helpful information about the document", "ancestors": [ "d305eb56c56fe7c2005e4a06", "9054c5552c631cc2ad46822b", "ebadc041eae79b890cc51c3c" ] }, "incomingRefs": [], "groups": [ "dd29ad3da8d5a1b29c4e2a49", { "_id": "6dc3cc30fde342e8cd8c652a", "provenance": "pariatur laboris nostrud consectetur ut", "name": "velit", "description": "anim deserunt dolore", "memberOf": [ { "groupId": "6e55ac4573abda3633147776", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "ipsum enim tempor minim mollit" }, { "roleId": "labore cillum esse amet tempor" }, { "roleId": "sed" }, { "roleId": "ea ut nostrud" } ], "inactive": false, "_meta": { "created": "1972-01-29T03:50:35.322Z", "updated": "1955-10-18T10:25:16.752Z", "migrationVersion": 98210221 } }, "a697c0659f9a74dc999d195e", "3d23d46aaf47e39398494004" ], "type": "operation", "metrics": { "start_time": "laboris", "end_time": 61265401.45385802, "server_id": "cillum sit pariatur adipisicing", "finish_state": "paused", "run_time": -17436358.937783897, "retrying": null, "user": { "_id": "73bd4fd4c96dd3eb7f38c980", "provenance": "exercitation", "username": "consectetur ullamco dolor", "firstname": "eiusmod voluptate dolore", "memberOf": [ { "groupId": "de8814962190327d431e28f3", "aaaManaged": false }, { "groupId": "f9bcac63161d0931cfbdbd2c", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "aliqua proident Duis ut" }, { "roleId": "labore culpa enim magna" }, { "roleId": "in ex" }, { "roleId": "anim in amet voluptate" }, { "roleId": "Ut quis fugiat sit" } ], "inactive": false, "lastLogin": "1957-11-25T20:54:06.464Z", "_meta": { "created": "1971-09-24T03:49:28.282Z", "updated": "1952-06-07T22:28:27.755Z", "migrationVersion": 50927724 }, "email": "id incididunt" }, "owner": { "_id": "37a802ebf9b4b884632d19cd", "provenance": "magna in labore sit in", "username": "non incididunt", "firstname": "pariatur ex ullamco non commodo", "memberOf": [ { "groupId": "089982dab6d9097cb8468e60", "aaaManaged": false }, { "groupId": "f2c42e5fc6db8e0b6f58b0da", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "id pariatur est" } ], "inactive": false, "lastLogin": "1946-10-07T22:17:43.114Z", "_meta": { "created": "1992-06-14T21:09:54.196Z", "updated": "2000-05-29T20:15:27.309Z", "migrationVersion": 55740300 }, "email": "id" } } } ], "metadata": { "skip": 6767093, "limit": -84023459, "total": 58022540, "nextPageSkip": null, "previousPageSkip": null, "currentPageSize": -24297533 } }
{ "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" } } } ] }