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": 0, "order": 1, "sort": "name", "include": "name", "exclude": "_id,description", "in": "culpa in", "not-in": "incididunt pariatur qui id", "equals": "eiusmod dolore proident sit", "contains": "id elit esse dolor ut", "starts-with": "minim eiusmod nulla incididunt consectetur", "ends-with": "culpa nulla aliquip commodo in", "dereference": "magna sit Ut", "gt": "dolor ea ex sit", "gte": "fugiat sit proident est ipsum", "lt": "adipisicing", "lte": "minim ad ex ipsum laborum", "q": "aute", "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": "57cFf9B0-AbAc-d7B4-184C-E8760DdE42AF", "location": "Application", "view": "nostrud veniam", "status": "scheduled", "app": "anim laborum", "name": "amet officia enim", "variables": { "decorators": [ { "type": "encryption", "pointer": "/f4E/O3W/L-,wAyeI/~0/~1" }, { "type": "encryption", "pointer": "/~0/QmfdV/q/t4i6Krzn/~0/~1/~0/~0/~1/~0" }, { "type": "encryption", "pointer": "/b/~0" }, { "type": "encryption", "pointer": "/~1/Tj/~1/dAZi/~1/hp/~1/jZ/ubq1Dw5t" } ] }, "last_updated": "1999-08-02T03:14:30.989Z", "encodingVersion": 1, "job": { "_id": "15fd9dbdb4cadd1def2590b1", "task": "b4f", "name": "myCoolDocumentName", "description": "Some helpful information about the document", "ancestors": null }, "groups": [ { "_id": "6d42f32bc7eb0adf531aab41", "provenance": "do sunt reprehenderit aute pariatur", "name": "in velit", "description": "pariatur mollit in eiusmod", "memberOf": [ { "groupId": "10715aa42424afc288c5ce45", "aaaManaged": true }, { "groupId": "570ac5cc57cfc46f7d181e61", "aaaManaged": false }, { "groupId": "2d772989d89c40239efa7773", "aaaManaged": false }, { "groupId": "3158ff310aa141a94bbe2b8e", "aaaManaged": false }, { "groupId": "aa109bebc1ba9ef9385b3a0b", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "Lorem aute in laborum" }, { "roleId": "aliquip cupidatat" }, { "roleId": "ut officia" }, { "roleId": "labore qui enim amet" } ], "inactive": false, "_meta": { "created": "1992-10-17T06:25:02.801Z", "updated": "2015-11-30T18:12:42.97Z", "migrationVersion": -95842137 } }, { "_id": "b01272ea4e691de8159d978b", "provenance": "in ut adipisicing amet id", "name": "fugiat in enim non voluptate", "description": "consequat reprehenderit laboris tempor magna", "memberOf": [ { "groupId": "652d68f65f9b80c030e7c485", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "reprehenderit nulla exercitation" }, { "roleId": "do elit et dolore" }, { "roleId": "sunt" }, { "roleId": "dolor non enim mollit" }, { "roleId": "in et nisi dolor" } ], "inactive": false, "_meta": { "created": "1957-05-03T03:57:48.989Z", "updated": "2015-06-06T15:43:16.488Z", "migrationVersion": 57994264 } } ], "type": "operation", "metrics": { "start_time": "qui", "end_time": 60358591.26054186, "server_id": "laborum", "finish_state": "success", "run_time": 24268802.759223625, "retrying": null, "user": "Pronghorn", "owner": "74fbfd045f82ad130879a493" } } ], "metadata": { "skip": 37709135, "limit": -3432380, "total": 45627024, "nextPageSkip": null, "previousPageSkip": 90902716, "currentPageSize": 3136509 } }
{ "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" } } } ] }