templategroup.get

Beschreibung

integer/array templategroup.get(object parameters)

Mit dieser Methode können Vorlagengruppen entsprechend den angegebenen Parametern abgerufen werden.

Diese Methode ist für Benutzer aller Typen verfügbar. Die Berechtigungen zum Aufrufen der Methode können in den Einstellungen der Benutzerrolle entzogen werden. Weitere Informationen finden Sie unter Benutzerrollen.

Parameter

(object) Parameter, die die gewünschte Ausgabe definieren.

Die Methode unterstützt die folgenden Parameter.

Parameter Type Beschreibung
graphids ID/array Gibt nur Vorlagengruppen zurück, die Vorlagen mit den angegebenen Graphen enthalten.
groupids ID/array Gibt nur Vorlagengruppen mit den angegebenen Vorlagengruppen-IDs zurück.
templateids ID/array Gibt nur Vorlagengruppen zurück, die die angegebenen Vorlagen enthalten.
triggerids ID/array Gibt nur Vorlagengruppen zurück, die Vorlagen mit den angegebenen Auslösern enthalten.
with_graphs boolean Gibt nur Vorlagengruppen zurück, die Vorlagen mit Graphen enthalten.
with_graph_prototypes boolean Gibt nur Vorlagengruppen zurück, die Vorlagen mit Graphprototypen enthalten.
with_httptests boolean Gibt nur Vorlagengruppen zurück, die Vorlagen mit Webprüfungen enthalten.
with_items boolean Gibt nur Vorlagengruppen zurück, die Vorlagen mit Datenpunkten enthalten.

Überschreibt die Parameter with_simple_graph_items.
with_item_prototypes boolean Gibt nur Vorlagengruppen zurück, die Vorlagen mit Datenpunktprototypen enthalten.

Überschreibt den Parameter with_simple_graph_item_prototypes.
with_simple_graph_item_prototypes boolean Gibt nur Vorlagengruppen zurück, die Vorlagen mit Datenpunktprototypen enthalten, die für die Erstellung aktiviert sind und einen numerischen Informationstyp haben.
with_simple_graph_items boolean Gibt nur Vorlagengruppen zurück, die Vorlagen mit numerischen Datenpunkten enthalten.
with_templates boolean Gibt nur Vorlagengruppen zurück, die Vorlagen enthalten.
with_triggers boolean Gibt nur Vorlagengruppen zurück, die Vorlagen mit Auslösern enthalten.
selectTemplates query Gibt eine Eigenschaft templates mit den Vorlagen zurück, die zur Vorlagengruppe gehören.

Unterstützt count.
limitSelects integer Begrenzt die Anzahl der Datensätze, die von Unterabfragen zurückgegeben werden.

Gilt für die folgenden Unterabfragen:
selectTemplates - Ergebnisse werden nach template sortiert.
sortfield string/array Sortiert das Ergebnis nach den angegebenen Eigenschaften.

Mögliche Werte: groupid, name.
countOutput boolean Diese Parameter sind im Referenzkommentar beschrieben.
editable boolean
excludeSearch boolean
filter object
limit integer
output query
preservekeys boolean
search object
searchByAny boolean
searchWildcardsEnabled boolean
sortorder string/array
startSearch boolean

Rückgabewerte

(integer/array) Gibt entweder Folgendes zurück:

  • ein Array von Objekten;
  • die Anzahl der abgerufenen Objekte, wenn der Parameter countOutput verwendet wurde.

Beispiele

Daten nach Namen abrufen

Rufen Sie alle Daten zu zwei Vorlagengruppen mit den Namen „Templates/Databases“ und „Templates/Modules“ ab.

Anfrage:

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

Antwort:

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

Siehe auch

Quelle

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