module.get

Descrizione

integer/array module.get(object parameters)

Questo metodo consente di recuperare i moduli in base ai parametri specificati.

Questo metodo è disponibile solo per il tipo di utente Super admin. I permessi per chiamare il metodo possono essere revocati nelle impostazioni del ruolo utente. Per ulteriori informazioni, vedere Ruoli utente.

Parametri

(object) Parametri che definiscono l'output desiderato.

Il metodo supporta i seguenti parametri.

Parametro Tipo Descrizione
moduleids ID/array Restituisce solo i moduli con gli ID specificati.
sortfield string/array Ordina il risultato in base alle proprietà specificate.

Valori possibili: moduleid, relative_path.
countOutput boolean Questi parametri sono descritti nel Commento di riferimento.
excludeSearch boolean
filter object
limit integer
output query
preservekeys boolean
search object
searchByAny boolean
searchWildcardsEnabled boolean
sortorder string/array
startSearch boolean

Valori restituiti

(integer/array) Restituisce uno dei seguenti:

  • un array di oggetti;
  • il numero di oggetti recuperati, se è stato utilizzato il parametro countOutput.

Esempi

Recupero di un modulo tramite ID

Recupera tutti i dati dei moduli "1", "2" e "25".

Richiesta:

{
    "jsonrpc": "2.0",
    "method": "module.get",
    "params": {
        "output": "extend",
        "moduleids": [
            "1",
            "2",
            "25"
        ]
    },
    "id": 1
}

Risposta:

{
    "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
}

Guarda anche

Fonte

CModule::get() in ui/include/classes/api/services/CModule.php.