templategroup.get

Opis

integer/array templategroup.get(object parameters)

Ta metoda umożliwia pobieranie grup szablonów zgodnie z podanymi parametrami.

Ta metoda jest dostępna dla użytkowników dowolnego typu. Uprawnienia do wywoływania tej metody mogą zostać cofnięte w ustawieniach roli użytkownika. Więcej informacji można znaleźć w sekcji Role użytkowników.

Parametry

(object) Parametry definiujące żądane dane wyjściowe.

Metoda obsługuje następujące parametry.

Parametr Typ Opis
graphids ID/array Zwracaj tylko grupy szablonów zawierające szablony z podanymi wykresami.
groupids ID/array Zwracaj tylko grupy szablonów o podanych identyfikatorach grup szablonów.
templateids ID/array Zwracaj tylko grupy szablonów zawierające podane szablony.
triggerids ID/array Zwracaj tylko grupy szablonów zawierające szablony z podanymi wyzwalaczami.
with_graphs boolean Zwracaj tylko grupy szablonów zawierające szablony z wykresami.
with_graph_prototypes boolean Zwracaj tylko grupy szablonów zawierające szablony z prototypami wykresów.
with_httptests boolean Zwracaj tylko grupy szablonów zawierające szablony z testami WWW.
with_items boolean Zwracaj tylko grupy szablonów zawierające szablony z pozycjami.

Nadpisuje parametry with_simple_graph_items.
with_item_prototypes boolean Zwracaj tylko grupy szablonów zawierające szablony z prototypami pozycji.

Nadpisuje parametr with_simple_graph_item_prototypes.
with_simple_graph_item_prototypes boolean Zwracaj tylko grupy szablonów zawierające szablony z prototypami pozycji, które są włączone do tworzenia i mają numeryczny typ informacji.
with_simple_graph_items boolean Zwracaj tylko grupy szablonów zawierające szablony z numerycznymi pozycjami.
with_templates boolean Zwracaj tylko grupy szablonów zawierające szablony.
with_triggers boolean Zwracaj tylko grupy szablonów zawierające szablony z wyzwalaczami.
selectTemplates query Zwracaj właściwość templates zawierającą szablony należące do grupy szablonów.

Obsługuje count.
limitSelects integer Ogranicza liczbę rekordów zwracanych przez podzapytania.

Dotyczy następujących podzapytań:
selectTemplates - wyniki będą sortowane według template.
sortfield string/array Sortuj wynik według podanych właściwości.

Możliwe wartości: groupid, name.
countOutput boolean Te parametry opisano w komentarzu referencyjnym.
editable boolean
excludeSearch boolean
filter object
limit integer
output query
preservekeys boolean
search object
searchByAny boolean
searchWildcardsEnabled boolean
sortorder string/array
startSearch boolean

Zwracane wartości

(integer/array) Zwraca:

  • tablicę obiektów;
  • liczbę pobranych obiektów, jeśli został użyty parametr countOutput.

Przykłady

Pobieranie danych według nazwy

Pobierz wszystkie dane o dwóch grupach szablonów o nazwach „Templates/Databases” oraz „Templates/Modules”.

Żądanie:

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

Odpowiedź:

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

Zobacz także

Źródło

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