Documentation
Table of Contents
module.get
¶Ù±ð²õ³¦°ù¾±±è³¦¾±¨®²Ô
integer/array module.get(object parameters)
El m¨¦todo permite recuperar m¨®dulos seg¨²n los par¨¢metros dados.
Este m¨¦todo est¨¢ disponible para usuarios de cualquier tipo. Los permisos para llamar al m¨¦todo se pueden revocar en la configuraci¨®n de roles de usuario. Consulte Roles de usuario para obtener m¨¢s informaci¨®n.
±Ê²¹°ù¨¢³¾±ð³Ù°ù´Ç²õ
(objeto) ±Ê²¹°ù¨¢³¾±ð³Ù°ù´Ç²õ que definen la salida deseada.
El m¨¦todo admite los siguientes par¨¢metros.
| ±Ê²¹°ù¨¢³¾±ð³Ù°ù´Ç | Tipo | ¶Ù±ð²õ³¦°ù¾±±è³¦¾±¨®²Ô |
|---|---|---|
| moduleids | ID/matriz | Devuelve s¨®lo m¨®dulos con los ID proporcionados. |
| sortfield | cadena/matriz | Ordena el resultado seg¨²n las propiedades dadas. Valores posibles: moduleid, relative_path. |
| countOutput | booleano | Estos par¨¢metros, que son comunes para todos los m¨¦todos get, se describen en detalle en la p¨¢gina Comentario de referencia. |
| excludeSearch | booleano | |
| filter | objeto | |
| limit | entero | |
| output | consulta | |
| preservekeys | booleano | |
| search | objeto | |
| searchByAny | booleano | |
| searchWildcardsEnabled | booleano | |
| sortorder | cadena/matriz | |
| startSearch | booleano |
Valores de devueltos
(integer/array) Devuelve:
- una matriz de objetos;
- la suma de los objetos devueltos, si el par¨¢metro
countOutputest¨¢ siendo usado
Ejemplos
Recuperar un m¨®dulo por ID
Recupere 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
}Ver tambi¨¦n
Fuente
CModule::get() en ui/include/classes/api/services/CModule.php.