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": 50, "order": 1, "sort": "name", "include": "name,description", "exclude": "description", "in": "anim voluptate tempor", "not-in": "culpa cupidatat Lorem esse ipsum", "equals": "dolore", "contains": "veniam dolor anim", "starts-with": "proident id commodo", "ends-with": "cillum Duis ad nostrud", "dereference": "sunt ut reprehenderit", "gt": "qui reprehenderit et incididunt labore", "gte": "velit nostrud", "lt": "labore ullamco", "lte": "sed in ex officia veniam", "q": "ut esse laboris", "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": "e8F7cC26-Ea8b-6C9A-54FC-2D953De1dB13", "location": "Adapter", "view": "commodo culpa laboris exercitation", "status": "error", "app": "sed fugiat dolor deserunt", "name": "ipsum consectetur in", "variables": { "decorators": [ { "type": "encryption", "pointer": "/CfQj9U9-Gp1/i2yp/~0/~1/~0/f3m,/~0/~0/e.Acr/ZGNo-X6Y/AM/Ug" }, { "type": "encryption", "pointer": "/TGshIuR2GF5/~1/q/~1/un/,z49n/sfAoPPBTd/pBZ1/wbyvc/~0/n/74FZa/~1" }, { "type": "encryption", "pointer": "/~0/YQDzke/~0/~1/LG+y/x5Ty/r,VddYfoE/~1/~1/xzkbY+WQX2h" }, { "type": "encryption", "pointer": "/~1/~1/~0" }, { "type": "encryption", "pointer": "/~1/~0" } ] }, "last_updated": "1978-07-30T07:50:53.116Z", "encodingVersion": 1, "job": { "_id": "9d5ecaf2bbfb43397bc3b778", "task": "3a1f", "name": "myCoolDocumentName", "description": "Some helpful information about the document", "ancestors": [ "efbfa5859b74c1014ed62ae7", "abf270a929fc6b69defebfff", "345e9a4f222a09199ac09e6f" ] }, "incomingRefs": [], "groups": [ "f15c845edf6373a8f031331f", "64eaf9c6a9ce57c2f3ac2235" ], "type": "operation", "metrics": { "start_time": "sed occaecat velit qui magna", "end_time": -98941804.82567419, "server_id": "consectetur occaecat sed", "finish_state": "complete", "run_time": 50876455.460637, "retrying": true, "user": "Pronghorn", "owner": { "_id": "4e2720eac35ede913f6b33f2", "provenance": "in", "username": "occaecat dolor in eiusmod", "firstname": "ut", "memberOf": [ { "groupId": "40388cff18d7c01d11fbfb12", "aaaManaged": false }, { "groupId": "7c12e02a37f312671a93b56b", "aaaManaged": false }, { "groupId": "8bade7df9861f9a87defbb20", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "sint consequat" }, { "roleId": "elit dolor pariatur" } ], "inactive": false, "lastLogin": "1946-05-23T23:49:39.989Z", "_meta": { "created": "2008-12-25T12:02:52.871Z", "updated": "1983-07-12T11:28:22.575Z", "migrationVersion": 67628894 }, "email": "nostrud" } } }, { "_id": "18CFf6f1-bee4-D6F7-0342-ECBCaF975544", "location": "Adapter", "view": "anim amet sunt", "status": "paused", "app": "anim", "name": "in veniam eu id", "variables": { "decorators": [ { "type": "encryption", "pointer": "/WabZh.+" }, { "type": "encryption", "pointer": "/M66C/~1/~0/UttiZcjOcIA" }, { "type": "encryption", "pointer": "/~0/E3/~0/~0/stpoFcG0/y/Kmkt4GK" }, { "type": "encryption", "pointer": "/~1/~0/zj/~0/~1/bsg-/2/~1/~0/Z8p/~1" }, { "type": "encryption", "pointer": "/~1/j8Vcx" } ] }, "last_updated": "1986-12-29T20:25:16.561Z", "encodingVersion": 1, "job": { "_id": "3fc2fecec28784ae009a6656", "task": "3a1f", "name": "myCoolDocumentName", "description": "Some helpful information about the document", "ancestors": [ "74c76d80e098aa5d5a54b8a0", "b2911c6b173258407b4e0e51", "d1192f2afa213d078ce0a6a1", "e9ebde24059d818b06de35b8" ] }, "incomingRefs": [], "groups": [ { "_id": "0e42596dbfd313daea2ef083", "provenance": "sunt veniam", "name": "in nulla proident", "description": "enim anim sed", "memberOf": [ { "groupId": "18b73577df8c756489534df4", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "do nulla ullamco culpa" }, { "roleId": "laboris sint" } ], "inactive": false, "_meta": { "created": "1973-06-18T03:16:17.34Z", "updated": "1976-06-04T08:17:01.72Z", "migrationVersion": -3159398 } } ], "type": "operation", "metrics": { "start_time": "ut", "end_time": 53306730.16403234, "server_id": "enim adipisicing aliqua proident", "finish_state": "success", "run_time": -53115910.52484168, "retrying": false, "user": "ad8a21bea45d9b4c831110d6", "owner": "1bf2c1eb65dcf85339eb8f3a" } } ], "metadata": { "skip": 63596272, "limit": 95095508, "total": 56964934, "nextPageSkip": 40982793, "previousPageSkip": null, "currentPageSize": -71893102 } }
{ "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" } } } ] }