templategroup.get

Description

integer/array templategroup.get(object parameters)

Cette méthode permet de récupérer les groupes de modèles selon les paramètres donnés.

Cette méthode est disponible pour les utilisateurs de tout type. Les autorisations d’appel de la méthode peuvent être révoquées dans les paramètres du rôle utilisateur. Voir User roles pour plus d’informations.

Paramètres

(object) Paramètres définissant la sortie souhaitée.

La méthode prend en charge les paramètres suivants.

Paramètre Type Description
graphids ID/array Retourner uniquement les groupes de modèles qui contiennent des modèles avec les graphes indiqués.
groupids ID/array Retourner uniquement les groupes de modèles avec les ID de groupes de modèles indiqués.
templateids ID/array Retourner uniquement les groupes de modèles qui contiennent les modèles indiqués.
triggerids ID/array Retourner uniquement les groupes de modèles qui contiennent des modèles avec les déclencheurs indiqués.
with_graphs boolean Retourner uniquement les groupes de modèles qui contiennent des modèles avec des graphes.
with_graph_prototypes boolean Retourner uniquement les groupes de modèles qui contiennent des modèles avec des prototypes de graphes.
with_httptests boolean Retourner uniquement les groupes de modèles qui contiennent des modèles avec des scénarios web.
with_items boolean Retourner uniquement les groupes de modèles qui contiennent des modèles avec des éléments.

Remplace les paramètres with_simple_graph_items.
with_item_prototypes boolean Retourner uniquement les groupes de modèles qui contiennent des modèles avec des prototypes d'éléments.

Remplace le paramètre with_simple_graph_item_prototypes.
with_simple_graph_item_prototypes boolean Retourner uniquement les groupes de modèles qui contiennent des modèles avec des prototypes d'éléments, qui sont activés pour la création et ont un type d'information numérique.
with_simple_graph_items boolean Retourner uniquement les groupes de modèles qui contiennent des modèles avec des éléments numériques.
with_templates boolean Retourner uniquement les groupes de modèles qui contiennent des modèles.
with_triggers boolean Retourner uniquement les groupes de modèles qui contiennent des modèles avec des déclencheurs.
selectTemplates query Retourner une propriété templates avec les modèles qui appartiennent au groupe de modèles.

Prend en charge count.
limitSelects integer Limite le nombre d'enregistrements renvoyés par les sous-sélections.

S'applique aux sous-sélections suivantes :
selectTemplates - les résultats seront triés par template.
sortfield string/array Trier le résultat selon les propriétés indiquées.

Valeurs possibles : groupid, name.
countOutput boolean Ces paramètres sont décrits dans le commentaire de référence.
editable boolean
excludeSearch boolean
filter object
limit integer
output query
preservekeys boolean
search object
searchByAny boolean
searchWildcardsEnabled boolean
sortorder string/array
startSearch boolean

Valeurs de retour

(integer/array) Renvoie soit :

  • un tableau d'objets ;
  • le nombre d'objets récupérés, si le paramètre countOutput a été utilisé.

Exemples

Récupération des données par nom

Récupérez toutes les données concernant deux groupes de modèles nommés "Templates/Databases" et "Templates/Modules".

Requête:

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

Réponse :

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

Voir aussi

Source

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