templategroup.get

Descrizione

integer/array templategroup.get(object parameters)

Il metodo consente di recuperare i gruppi di template in base ai parametri specificati.

Questo metodo è disponibile per gli utenti di qualsiasi tipo. Le autorizzazioni per chiamare il metodo possono essere revocate 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 Type Descrizione
graphids ID/array Restituisce solo i gruppi di template che contengono template con i grafici specificati.
groupids ID/array Restituisce solo i gruppi di template con gli ID dei gruppi di template specificati.
templateids ID/array Restituisce solo i gruppi di template che contengono i template specificati.
triggerids ID/array Restituisce solo i gruppi di template che contengono template con i trigger specificati.
with_graphs boolean Restituisce solo i gruppi di template che contengono template con grafici.
with_graph_prototypes boolean Restituisce solo i gruppi di template che contengono template con prototipi di grafico.
with_httptests boolean Restituisce solo i gruppi di template che contengono template con controlli web.
with_items boolean Restituisce solo i gruppi di template che contengono template con item.

Sovrascrive i parametri with_simple_graph_items.
with_item_prototypes boolean Restituisce solo i gruppi di template che contengono template con prototipi di item.

Sovrascrive il parametro with_simple_graph_item_prototypes.
with_simple_graph_item_prototypes boolean Restituisce solo i gruppi di template che contengono template con prototipi di item, abilitati per la creazione e con tipo di informazione numerico.
with_simple_graph_items boolean Restituisce solo i gruppi di template che contengono template con item numerici.
with_templates boolean Restituisce solo i gruppi di template che contengono template.
with_triggers boolean Restituisce solo i gruppi di template che contengono template con trigger.
selectTemplates query Restituisce una proprietà templates con i template che appartengono al gruppo di template.

Supporta count.
limitSelects integer Limita il numero di record restituiti dalle sotto-selezioni.

Si applica alle seguenti sotto-selezioni:
selectTemplates - i risultati saranno ordinati per template.
sortfield string/array Ordina il risultato in base alle proprietà specificate.

Valori possibili: groupid, name.
countOutput boolean Questi parametri sono descritti nel commento di riferimento.
editable boolean
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 dei dati per nome

Recupera tutti i dati relativi a due gruppi di template denominati "Templates/Databases" e "Templates/Modules".

Richiesta:

{
    "jsonrpc": "2.0",
    "method": "templategroup.get",
    "params": {
        "output": "extend",
        "filter": {
            "name": [
                "Templates/Databases",
                "Templates/Modules"
            ]
        }
    },
    "id": 1
}

Risposta:

{
    "jsonrpc": "2.0",
    "result": [
        {
            "groupid": "13",
            "name": "Templates/Databases",
            "uuid": "748ad4d098d447d492bb935c907f652f"
        },
        {
            "groupid": "8",
            "name": "Templates/Modules",
            "uuid": "57b7ae836ca64446ba2c296389c009b7"
        }
    ],
    "id": 1
}

Guarda anche

Fonte

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