Documentation
Table of Contents
regexp.get
説明
integer/array regexp.get(object parameters)
このメソッドで、指定されたパラメーターに従ってグローバル正規表現を取得できます。
このメソッドはSuper adminユーザータイプでのみ使用できます。 メソッドを呼び出す権限は、ユーザーロール設定で取り消すことができます。 詳細についてはユーザーの役割を参照してください。
パラメータ
(object) 目的の出力を定義するパラメーター
このメソッドは、次のパラメーターをサポートします
| パラメータ | タイプ | 説明 |
|---|---|---|
| regexpids | string/array | 指定されたIDを持つ正規表現のみを返します |
| selectExpressions | query | expressionsプロパティを返します |
| sortfield | string/array | 指定されたプロパティで結果を並べ替えます 利用可能な値は、 regexpidとnameです。 |
| countOutput | boolean | すべてのgetメソッドに共通するこれらのパラメーターについてはリファレンス解説ページで詳しく説明されています。 |
| editable | boolean | |
| excludeSearch | boolean | |
| filter | object | |
| limit | integer | |
| output | query | |
| preservekeys | boolean | |
| search | object | |
| searchByAny | boolean | |
| searchWildcardsEnabled | boolean | |
| sortorder | string/array | |
| startSearch | boolean |
戻り値
(integer/array) 次のいずれかを返します:
- オブジェクトの配列
countOutputパラメータが使用されている場合、取得されたオブジェクトの数
例
グローバル正規表現の取得
Request:
{ "jsonrpc": "2.0", "method": "regexp.get", "params": { "output": ["regexpid", "name"], "selectExpressions": ["expression", "expression_type"], "regexpids": [1, 2], "preservekeys": true }, "auth": "038e1d7b1735c6a5436ee9eae095879e", "id": 1 }Response:
{ "jsonrpc": "2.0", "result": { "1": { "regexpid": "1", "name": "File systems for discovery", "expressions": [ { "expression": "^(btrfs|ext2|ext3|ext4|reiser|xfs|ffs|ufs|jfs|jfs2|vxfs|hfs|apfs|refs|ntfs|fat32|zfs)$", "expression_type": "3" } ] }, "2": { "regexpid": "2", "name": "Network interfaces for discovery", "expressions": [ { "expression": "^Software Loopback Interface", "expression_type": "4" }, { "expression": "^(In)?[Ll]oop[Bb]ack[0-9._]*$", "expression_type": "4" }, { "expression": "^NULL[0-9.]*$", "expression_type": "4" }, { "expression": "^[Ll]o[0-9.]*$", "expression_type": "4" }, { "expression": "^[Ss]ystem$", "expression_type": "4" }, { "expression": "^Nu[0-9.]*$", "expression_type": "4" } ] } }, "id": 1 }ソース
CRegexp::get() in ui/include/classes/api/services/CRegexp.php.