integer/array module.get(object parameters)
El método permite recuperar módulos según los parámetros dados.
Este método solo está disponible para el tipo de usuario Super admin. Los permisos para llamar al método pueden ser revocados en la configuración de roles de usuario. Consulte Roles de usuario para obtener más información.
(object)
Parámetros que definen la salida deseada.
El método admite los siguientes parámetros.
Parámetro | Tipo | Descripción |
---|---|---|
moduleids | ID/array | Devolver solo los módulos con los IDs indicados. |
sortfield | string/array | Ordenar el resultado por las propiedades indicadas. Valores posibles: moduleid , relative_path . |
countOutput | boolean | Estos parámetros se describen en el Comentario de referencia. |
excludeSearch | boolean | |
filter | object | |
limit | integer | |
output | query | |
preservekeys | boolean | |
search | object | |
searchByAny | boolean | |
searchWildcardsEnabled | boolean | |
sortorder | string/array | |
startSearch | boolean |
(integer/array)
Devuelve:
countOutput
.Recuperar todos los datos sobre los módulos "1", "2" y "25".
{
"jsonrpc": "2.0",
"method": "module.get",
"params": {
"output": "extend",
"moduleids": [
"1",
"2",
"25"
]
},
"id": 1
}
Respuesta:
{
"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() en ui/include/classes/api/services/CModule.php.