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": 1, "order": 1, "sort": "name", "include": "name", "exclude": "_id", "in": "mollit dolore est", "not-in": "magna deserunt incididunt Ut", "equals": "esse laborum adipisicing in fugiat", "contains": "Ut Duis ullamco qui", "starts-with": "in occaecat do esse", "ends-with": "ex", "dereference": "laborum tempor", "gt": "officia deserunt reprehenderit aliqua quis", "gte": "Ut", "lt": "ut do in", "lte": "dolore dolor pariatur", "q": "dolore", "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": "3337A8C2-E6aC-2EFb-F1eC-B8db76EcfBDD", "location": "Application", "view": null, "status": "error", "app": "dolor dolore", "name": "ad culpa", "variables": { "decorators": [ { "type": "encryption", "pointer": "/~0/~1" }, { "type": "encryption", "pointer": "/w/aFY+sZIlVa/~1/~1/Y7/~1/tjcNWssGI/QdNQEU/~0/A1GZN,r/~1" } ] }, "last_updated": "1983-09-14T07:05:11.732Z", "encodingVersion": 1, "job": { "_id": "214ea48fc759fd18b0300b3d", "task": "e28f", "name": "myCoolDocumentName", "description": "Some helpful information about the document", "ancestors": null }, "groups": [ { "_id": "2a6ddb2ffa0d38b875312411", "provenance": "est qui", "name": "tempor", "description": "velit", "memberOf": [ { "groupId": "f88359b54a2d372612b7446d", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "aliqua Excepteur Ut labore" }, { "roleId": "anim qui mollit Ut" }, { "roleId": "incididunt consequat officia veniam" } ], "inactive": true, "_meta": { "created": "1972-07-10T04:14:04.845Z", "updated": "1957-07-10T21:18:52.173Z", "migrationVersion": 39440477 } } ], "type": "manual", "metrics": { "start_time": "irure sunt qui et", "claim_time": "1989-10-24T15:26:24.866Z", "end_time": -34650163.544558674, "server_id": "elit consequat labore eiusmod", "finish_state": "paused", "run_time": -12496785.377438486, "user": "7cbc115b555bdde092b00b3e", "owner": { "_id": "25c15900c3d03ad43e578271", "provenance": "quis qui minim", "username": "consectetur cillum ea ex", "firstname": "ex sit dolor", "memberOf": [ { "groupId": "fe842492484f424df12b2c01", "aaaManaged": true }, { "groupId": "9efb599367ab663147d85835", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "ex laborum sed" }, { "roleId": "in" } ], "inactive": true, "lastLogin": "1954-04-05T04:10:27.491Z", "_meta": { "created": "1996-11-17T22:20:13.65Z", "updated": "2015-07-10T05:30:14.427Z", "migrationVersion": 3937167 }, "email": "elit voluptate cillum adipisicing officia" } } } ], "metadata": { "skip": -31349051, "limit": 7430482, "total": 83403954, "nextPageSkip": 12800650, "previousPageSkip": null, "currentPageSize": -13323382 } }
{ "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" } } } ] }