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": 0, "order": 1, "sort": "name", "include": "name", "exclude": "_id", "in": "tempor laboris in", "not-in": "do cillum Excepteur enim commodo", "equals": "sunt ad deserunt sit dolor", "contains": "in enim ad sint eu", "starts-with": "tempor do", "ends-with": "nulla dolore adipisicing aute", "dereference": "exercitation Excepteur incididunt", "gt": "anim dolor non cupidatat proident", "gte": "eiusmod ipsum", "lt": "adipisicing velit occaecat mollit dolore", "lte": "dolor mollit", "q": "sed ullamco voluptate qui nisi", "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": "9A567880-12bA-ADf5-646E-AF9A375306b9", "location": "Adapter", "view": null, "status": "canceled", "app": "nisi non deserunt commodo ad", "name": "sint nulla", "variables": { "decorators": [ { "type": "encryption", "pointer": "/~0/ki-a5r-BgMa/Ru/Vg6W2XxEOk/GqLCg" }, { "type": "encryption", "pointer": "/~0/E5T" }, { "type": "encryption", "pointer": "/~0/~1/i1Rih+y/rclq8M6/~1/~1/pQ/~1" } ] }, "last_updated": "1949-10-01T14:15:43.338Z", "encodingVersion": 1, "job": { "_id": "4cf3cd8a4a188707bce8b621", "task": "3a1f", "name": "myCoolDocumentName", "description": "Some helpful information about the document", "ancestors": [ "5620a8b7cf395a66ce3cef05" ] }, "groups": [ "258c094a3d86aca2eb6747c0" ], "type": "operation", "metrics": { "start_time": "nisi in eiusmod", "end_time": 66350056.37110624, "server_id": "exercitation labore nulla do proident", "finish_state": "success", "run_time": 10632965.980009064, "retrying": true, "user": "35124ce5a682fe5ff58b179c", "owner": "" } } ], "metadata": { "skip": 8626172, "limit": -11617601, "total": -29309478, "nextPageSkip": 70851359, "previousPageSkip": null, "currentPageSize": -89781210 } }
{ "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" } } } ] }