Documentation
Table of Contents
module.get
説明
integer/array module.get(object parameters)
このメソッドは、指定したパラメーターに応じたモジュールを取得できます。
このメソッドは、すべてのタイプのユーザーが利用できます。メソッドを呼び出す権限は、ユーザーの役割の設定で取り消すことができます。詳細はユーザーの役割を参照してください。
パラメータ
(object) 出力を定義するパラメータ
このメソッドは以下のパラメータをサポートしています。
| パラメータ | 型 | 説明 |
|---|---|---|
| moduleids | ID/配列 | 指定されたIDを持つモジュールのみを返します。 |
| sortfield | 文字列/配列 | 指定されたプロパティで結果を並べ替えます。 使用可能な値: moduleid、relative_path |
| countOutput | boolean | これらのパラメータについては、リファレンス解説で説明されています。 |
| excludeSearch | boolean | |
| filter | object | |
| limit | integer | |
| output | query | |
| preservekeys | ブール値 | |
| search | オブジェクト | |
| searchByAny | ブール値 | |
| searchWildcardsEnabled | ブール値 | |
| sortorder | 文字列/配列 | |
| startSearch | ブール値 |
戻り値
(integer/array) 次のいずれかを返します:
- オブジェクトの配列
countOutputパラメータが使用されている場合、取得されたオブジェクトの数
例
ID でモジュールを取得する
モジュール"1"、"2"、"25"に関するすべてのデータを取得します。
{
"jsonrpc": "2.0",
"method": "module.get",
"params": {
"output": "extend",
"moduleids": [
"1",
"2",
"25"
]
},
"id": 1
}Response:
{
"jsonrpc": "2.0",
"result": [
{
"moduleid": "1",
"id": "actionlog",
"relative_path": "widgets/actionlog",
"status": "1",
"config": []
},
{
"moduleid": "2",
"id": "clock",
"relative_path": "widgets/clock",
"status": "1",
"config": []
},
{
"moduleid": "25",
"id": "example",
"relative_path": "modules/example_module",
"status": "1",
"config": []
}
],
"id": 1
}参照
ソース
CModule::get() in ui/include/classes/api/services/CModule.php.