Documentation
Table of Contents
templategroup.get
Descripció
integer/array templategroup.get(object parameters)
El mètode permet recuperar grups de plantilles segons els paràmetres proveïts.
Aquest mètode és disponible per a usuaris de qualsevol mena. Els permisos per cridar al mètode es poden revocar a les configuracions de rols d'usuari. Per a més informació, veieu Rols d'usuari.
Paràmetres
(objecte) Paràmetres que defineixen la sortida esperada.
El mètode admet els paràmetres següents.
| Paràmetre | Tipus | Descripció |
|---|---|---|
| graphids | string/array | Retorna només grups de plantilles que contenen plantilles amb els gràfics donats. |
| groupids | string/array | Retorna només grups de plantilles amb els ID de grup de plantilles donats. |
| templateids | string/array | Retorna només grups de plantilles que contenen les plantilles donades. |
| triggerids | string/array | Retorna només grups de plantilles que contenen plantilles amb els triggers donats. |
| with_graphs | flag | Retorna només grups de plantilles que contenen plantilles amb gràfics. |
| with_graph_prototypes | flag | Retorna només grups de plantilles que contenen plantilles amb prototips de gràfics. |
| with_httptests | flag | Retorna només grups de plantilles que contenen plantilles amb comprovacions web. |
| with_items | flag | Retorna només grups de plantilles que contenen plantilles amb elements. Substitueix els paràmetres with_simple_graph_items. |
| with_item_prototypes | flag | Retorna només grups de plantilles que contenen plantilles amb prototips d'elements. Substitueix el paràmetre with_simple_graph_item_prototypes. |
| with_simple_graph_item_prototypes | flag | Retorna només grups de plantilles que contenen plantilles amb prototips d'elements, que són habilitats per a la creació i tenen informació de tipus numèric. |
| with_simple_graph_items | flag | Retorna només grups de plantilles que contenen plantilles amb elements numèrics. |
| with_templates | flag | Retorna només grups de plantilles que contenen plantilles. |
| with_triggers | flag | Retorna només grups de plantilles que contenen plantilles amb triggers. |
| selectTemplates | query | Retorna una propietat templates amb les plantilles que pertanyen al grup de plantilles. Admet count. |
| limitSelects | integer | Limita el nombre de registres retornats per subseleccions. S'aplica a les subseleccions següents: selectTemplates: els resultats s'ordenaran per plantilla. |
| sortfield | string/array | Ordena el resultat per les propietats donades. Valors possibles: groupid, name. |
| countOutput | boolean | Aquests paràmetres que són comuns per a tots els mètodes get es descriuen en detall a la pàgina comentari de referència. |
| editable | boolean | |
| excludeSearch | boolean | |
| filter | object | |
| limit | integer | |
| output | query | |
| preservekeys | boolean | |
| search | object | |
| searchByAny | boolean | |
| searchWildcardsEnabled | boolean | |
| sortorder | string/array | |
| startSearch | boolean |
Valors de retorn
(integer/array) Retorna un d'entre:
- una taula d'objectes;
- el recompte d'objectes recuperats, si s'empra el paràmetre
countOutput.
Exemples
Recuperar informació per nom
Recupera tota la informació de dos grups de plantilles anomenats all data about two template groups named "Plantilles/Bases de dades" i "Plantilles/Mòduls".
{
"jsonrpc": "2.0",
"method": "templategroup.get",
"params": {
"output": "extend",
"filter": {
"name": [
"Plantilles/Bases de dades",
"Plantilles/Mòduls"
]
}
},
"id": 1
}Resposta:
{
"jsonrpc": "2.0",
"result": [
{
"groupid": "13",
"name": "Plantilles/Bases de dades",
"uuid": "748ad4d098d447d492bb935c907f652f"
},
{
"groupid": "8",
"name": "Plantilles/Mòduls",
"uuid": "57b7ae836ca64446ba2c296389c009b7"
}
],
"id": 1
}Veieu també
Font
CTemplateGroup::get() a ui/include/classes/api/services/CTemplateGroup.php.