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": "description", "in": "exercitation qui", "not-in": "sunt anim quis magna", "equals": "reprehenderit aute in", "contains": "nulla consectetur veniam eiusmod", "starts-with": "ad proident ut culpa dolor", "ends-with": "id incididunt deserunt laborum cupidatat", "dereference": "veniam elit Excepteur aute ipsum", "gt": "culpa", "gte": "fugiat", "lt": "aliquip deserunt ex", "lte": "nisi sunt ad voluptate", "q": "nulla nostrud", "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": "BeCDDcDb-3EE8-7E9c-ecB0-a23508707fA2", "location": "Application", "view": "culpa sunt", "status": "scheduled", "app": "ut nisi dolor pariatur qui", "name": "sed in sit", "variables": { "decorators": [ { "type": "encryption", "pointer": "/o.Zwc7QxC2/~1" }, { "type": "encryption", "pointer": "/~1" }, { "type": "encryption", "pointer": "/~1/EZ5lsiB/NJu2-/Ne95eUSp+/~0/nVPZvR/~1/~0" }, { "type": "encryption", "pointer": "/~1/hKgMo/vb4HblJD9Vd/aqYc+FKi1j/~1/egcg" }, { "type": "encryption", "pointer": "/~1" } ] }, "last_updated": "2002-06-23T11:28:54.841Z", "encodingVersion": 1, "job": { "_id": "e353e009fc8b695b43decc86", "task": "3a1f", "name": "myCoolDocumentName", "description": "Some helpful information about the document", "ancestors": [ "64a2359ef046afaa8372371c", "ed9c06671c9f0611d9adc777", "f6079a4a488b561059e01f41" ] }, "incomingRefs": [], "groups": [ { "_id": "8df8aaf06c4f4d97c6ec33e1", "provenance": "aliquip id esse qui", "name": "Duis in", "description": "sit Excepteur velit elit", "memberOf": [ { "groupId": "ace9ca7f422da533b4d8b9a4", "aaaManaged": true }, { "groupId": "9167d94d40739128d532c144", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "pariatur" }, { "roleId": "id" } ], "inactive": false, "_meta": { "created": "2004-02-23T23:23:02.077Z", "updated": "1967-05-25T17:01:29.018Z", "migrationVersion": 73469285 } }, { "_id": "77d04991ac700762ab372d6f", "provenance": "cupidatat Duis aliqua voluptate", "name": "occaecat sunt amet", "description": "nostrud est quis ea", "memberOf": [ { "groupId": "dcccbfff25a88343721bfb2c", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "velit" }, { "roleId": "tempor reprehenderit sunt" }, { "roleId": "eu eiusmod sit" }, { "roleId": "Excepteur" } ], "inactive": false, "_meta": { "created": "2000-11-24T21:09:32.668Z", "updated": "1946-08-08T11:57:30.294Z", "migrationVersion": -62184012 } }, "cec591e2d43257750fc62884" ], "type": "operation", "metrics": { "start_time": "elit mollit", "end_time": 23252720.3914648, "server_id": "nostrud cupidatat exercitation", "finish_state": "canceled", "run_time": 89197226.82327384, "retrying": false, "user": "", "owner": "e2dccc5fe6e3d8d70665c003" } }, { "_id": "f34c3B6e-168F-B9ae-E410-4DbfBd2ceF49", "location": "Adapter", "view": "occaecat magna officia ipsum id", "status": "error", "app": "eiusmod nisi dolor Excepteur quis", "name": "reprehenderit", "variables": { "decorators": [ { "type": "encryption", "pointer": "/~1/OBRW/~0" }, { "type": "encryption", "pointer": "/~1" }, { "type": "encryption", "pointer": "/~1/~1/~0/q/~1/s0utvF5/Fzalaf7neA/Lj7.k4+1zk/~1/~0/Q1ri+0i0a" } ] }, "last_updated": "1990-08-16T13:16:02.453Z", "encodingVersion": 1, "job": { "_id": "9d7d622dd43b30da832c6944", "task": "e28f", "name": "myCoolDocumentName", "description": "Some helpful information about the document", "ancestors": [ "437851e74652d6357f1d1db5" ] }, "incomingRefs": [], "groups": [ { "_id": "385ebc66368f06fabbf66eb0", "provenance": "enim", "name": "adipisicing exercitation commodo", "description": "qui proident ipsum Excepteur", "memberOf": [ { "groupId": "e7d463a0ba6147adc1bd11bf", "aaaManaged": false }, { "groupId": "b3d1c5a4c3d14c33d27fcbf9", "aaaManaged": false }, { "groupId": "acc1b947b4b86dc04f932a31", "aaaManaged": true }, { "groupId": "778a8281b8fa493b015ffa18", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "reprehenderit ut" }, { "roleId": "nulla culpa laborum aliqua velit" }, { "roleId": "veniam sed ex nulla" }, { "roleId": "dolor nisi in culpa est" }, { "roleId": "non dolor dolore nostrud mollit" } ], "inactive": true, "_meta": { "created": "1969-10-26T07:20:33.987Z", "updated": "1964-10-29T06:25:10.695Z", "migrationVersion": 88896096 } }, { "_id": "b57729a2514b285c27b9b4d6", "provenance": "ad consectetur mollit", "name": "veniam laborum", "description": "est", "memberOf": [ { "groupId": "9508867fc5bd91b86212abd1", "aaaManaged": true }, { "groupId": "a1a6c05b1a29a2a87f2c039e", "aaaManaged": false }, { "groupId": "8e73e5c5029f60716b47f4e4", "aaaManaged": true }, { "groupId": "d0fc267f16002ba927658071", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "adipisicing eiusmod" }, { "roleId": "anim ullamco commodo" } ], "inactive": false, "_meta": { "created": "1961-06-22T11:49:35.408Z", "updated": "1969-12-04T06:25:53.545Z", "migrationVersion": 34656330 } }, "54062e4055ac2d178221a693", { "_id": "2d31317b81d1a5788e794847", "provenance": "anim", "name": "ut et", "description": "id labore sunt", "memberOf": [ { "groupId": "88d6a0c885ff65017322cb24", "aaaManaged": true }, { "groupId": "6a9cad83139a31c8b4d0687e", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "irure eu ut dolor" }, { "roleId": "nostrud" }, { "roleId": "ut amet ex consequat" } ], "inactive": false, "_meta": { "created": "1959-12-07T23:05:03.566Z", "updated": "2004-07-02T13:08:44.504Z", "migrationVersion": 28632527 } }, "fd45d24e5c55a61f4f16652a" ], "type": "operation", "metrics": { "start_time": "mollit", "end_time": -16597989.264378384, "server_id": "irure anim", "finish_state": "canceled", "run_time": -42763079.75845617, "retrying": true, "user": "9013b010f6de8b6a10214060", "owner": "1f725cc6c6eff1b862c15272" } }, { "_id": "ef7de96b-fC86-c00E-39D2-A33DEAD6cED7", "location": "Application", "view": null, "status": "complete", "app": "dolor", "name": "ex ad", "variables": { "decorators": [ { "type": "encryption", "pointer": "/~0/YK/~0/~1/Lu,mZx6o.6e/~1/~0/~0/jAPG8xytW" }, { "type": "encryption", "pointer": "/TF4Yu4Xe./aY9Dt1wy/-F/Eky,jA6/MmgQEuil/~0/~0/~1" }, { "type": "encryption", "pointer": "/VXTyp,t/~1/BLf5fS/FlEx/pV3Hx3e5-T/~1" }, { "type": "encryption", "pointer": "/~0/~0/~0/V5Y8wYT/Hd/pjcLv82D/aA./~1/Y" }, { "type": "encryption", "pointer": "/~0/~1/~1/~1/EmHYfxdpj/~0/~1" } ] }, "last_updated": "1970-04-18T19:56:50.989Z", "encodingVersion": 1, "job": { "_id": "1c3c1f82da147c3b1240e341", "task": "e28f", "name": "myCoolDocumentName", "description": "Some helpful information about the document", "ancestors": null }, "incomingRefs": [], "groups": [ "39c9c5b1494e0e1aac783864" ], "type": "operation", "metrics": { "start_time": "deserunt", "end_time": 78290236.58742908, "server_id": "ullamco in nulla", "finish_state": "scheduled", "run_time": -40603719.05927131, "retrying": false, "user": "Pronghorn", "owner": "Pronghorn" } }, { "_id": "0ec4Fe34-Fd9f-53eD-a68c-6CBE53ba32A6", "location": "Broker", "view": null, "status": "running", "app": "anim Ut", "name": "ea", "variables": { "decorators": [ { "type": "encryption", "pointer": "/YCveXAXV68/~0/~0" }, { "type": "encryption", "pointer": "/a" }, { "type": "encryption", "pointer": "/D,C/~1/XGqs/qpP4Sb/a/Gwups4d./~1/~0/pIBS6tY2H" }, { "type": "encryption", "pointer": "/Fkx2/RT/aZEc/IY,7XxB/~1" } ] }, "last_updated": "1990-08-11T15:11:00.852Z", "encodingVersion": 1, "job": { "_id": "e85f67c1159ca6dc412ed013", "task": "e28f", "name": "myCoolDocumentName", "description": "Some helpful information about the document", "ancestors": null }, "incomingRefs": [], "groups": [ { "_id": "e97bf1891712ff9a1d2697c8", "provenance": "ullamco", "name": "officia pariatur", "description": "sunt Lorem non dolor", "memberOf": [ { "groupId": "01d327845a1ea3711d6e3f38", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "exercitation Duis consequat pariatur" }, { "roleId": "sed non deserunt dolor" }, { "roleId": "amet velit mollit" }, { "roleId": "sed" } ], "inactive": true, "_meta": { "created": "2018-07-10T16:11:59.164Z", "updated": "1971-12-31T15:40:05.905Z", "migrationVersion": 2691537 } }, { "_id": "a7389ab17db4dd9b03190048", "provenance": "dolore minim aliquip dolor", "name": "tempor", "description": "proident minim in exercitation eiusmod", "memberOf": [ { "groupId": "bd64e5bb18ea72ac0c3cddaa", "aaaManaged": false }, { "groupId": "b9b456982835fc226913f132", "aaaManaged": true }, { "groupId": "f0e14725dd1dc16f43ba4114", "aaaManaged": false }, { "groupId": "499828f6a16e3ea479d7e8b9", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "sit" } ], "inactive": false, "_meta": { "created": "2015-09-04T22:03:31.635Z", "updated": "1966-05-22T15:10:04.99Z", "migrationVersion": -40951256 } }, "6c8de448a2ff09458e757590" ], "type": "operation", "metrics": { "start_time": "velit occaecat", "end_time": 72634515.26065737, "server_id": "do", "finish_state": "paused", "run_time": -44434994.17087957, "retrying": false, "user": "Pronghorn", "owner": "349aba3b8c71f2c980fa175a" } }, { "_id": "DF05CBeD-8E07-9D91-Df5F-eab2a3FfEdAA", "location": "Adapter", "view": "reprehenderit", "status": "scheduled", "app": "Duis eiusmod cupidatat id", "name": "aute magna", "variables": { "decorators": [ { "type": "encryption", "pointer": "/rZK3uEuX+/PvlOG/~0/R,K+CR9,NX/~0/~1/CbY9/FiMI/KBsZM" }, { "type": "encryption", "pointer": "/~0/PjITd/MH.bX9V2U/~1/PyyACkN" }, { "type": "encryption", "pointer": "/GNxxktrhkh/QiOZlcOo/~1/yQDABfSri" } ] }, "last_updated": "2021-03-23T05:26:32.193Z", "encodingVersion": 1, "job": { "_id": "11e7a1701e446118e7811076", "task": "e28f", "name": "myCoolDocumentName", "description": "Some helpful information about the document", "ancestors": null }, "incomingRefs": [], "groups": [ "1fab0e66635525a806491c3c", "1628b81cdbfd342d91c677f9", "2a5c07020d0d61ef79719824" ], "type": "operation", "metrics": { "start_time": "laboris voluptate eu", "end_time": -23662100.930249393, "server_id": "est sit reprehenderit", "finish_state": "success", "run_time": -78155438.110986, "retrying": null, "user": "", "owner": "" } } ], "metadata": { "skip": -42733020, "limit": 18636420, "total": 717129, "nextPageSkip": null, "previousPageSkip": null, "currentPageSize": 87976899 } }
{ "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" } } } ] }