[comment]: # ({c7f20528-f9e8f670})
# templategroup.get

[comment]: # ({/c7f20528-f9e8f670})

[comment]: # ({97635317-b5ff62ed})
### Описание

`integer/array templategroup.get(параметры объекта)`

Метод позволяет получить группы шаблонов в соответствии с заданными параметрами.

::: noteclassic
Этот метод доступен пользователям любого типа.
Разрешения на вызов метода можно отозвать в настройках ролей пользователя.
Дополнительную информацию см. в разделе [Роли пользователей](/manual/web_interface/frontend_sections/users/user_roles).
:::

[comment]: # ({/97635317-b5ff62ed})

[comment]: # ({6d7dd702-6102edd8})
### Параметры

`(object)` Параметры, определяющие требуемый результат.

Метод поддерживает следующие параметры.

|Parameter|[Type](/manual/api/reference_commentary#data-types)|Description|
|--|--|------|
|graphids|ID/array|Возвращать только группы шаблонов, которые содержат шаблоны с указанными графиками.|
|groupids|ID/array|Возвращать только группы шаблонов с указанными идентификаторами групп шаблонов.|
|templateids|ID/array|Возвращать только группы шаблонов, которые содержат указанные шаблоны.|
|triggerids|ID/array|Возвращать только группы шаблонов, которые содержат шаблоны с указанными триггерами.|
|with\_graphs|boolean|Возвращать только группы шаблонов, которые содержат шаблоны с графиками.<br><br>Переопределяет параметры `with_simple_graph_items`.|
|with\_graph\_prototypes|boolean|Возвращать только группы шаблонов, которые содержат шаблоны с прототипами графиков.|
|with\_httptests|boolean|Возвращать только группы шаблонов, которые содержат шаблоны с веб-проверками.|
|with\_items|boolean|Возвращать только группы шаблонов, которые содержат шаблоны с элементами данных.<br><br>Переопределяет параметр `with_simple_graph_items`.|
|with\_item\_prototypes|boolean|Возвращать только группы шаблонов, которые содержат шаблоны с прототипами элементов данных.<br><br>Переопределяет параметр `with_simple_graph_item_prototypes`.|
|with\_simple\_graph\_item\_prototypes|boolean|Возвращать только группы шаблонов, которые содержат шаблоны с прототипами элементов данных, включенными для создания и имеющими числовой тип информации.|
|with\_simple\_graph\_items|boolean|Возвращать только группы шаблонов, которые содержат шаблоны с числовыми элементами данных.|
|with\_templates|boolean|Возвращать только группы шаблонов, которые содержат шаблоны.|
|with\_triggers|boolean|Возвращать только группы шаблонов, которые содержат шаблоны с триггерами.|
|selectTemplates|query|Возвращать свойство [`templates`](/manual/api/reference/template/object) с шаблонами, которые принадлежат группе шаблонов.<br><br>Поддерживает `count`.|
|limitSelects|integer|Ограничивает количество записей, возвращаемых подзапросами.<br><br>Применяется к следующим подзапросам:<br>`selectTemplates` - результаты будут отсортированы по `template`.|
|sortfield|string/array|Сортировать результат по указанным свойствам.<br><br>Возможные значения: `groupid`, `name`.|
|countOutput|boolean|Эти параметры описаны в [комментарии к справочнику](/manual/api/reference_commentary#common-get-method-parameters).|
|editable|boolean|^|
|excludeSearch|boolean|^|
|filter|object|^|
|limit|integer|^|
|output|query|^|
|preservekeys|boolean|^|
|search|object|^|
|searchByAny|boolean|^|
|searchWildcardsEnabled|boolean|^|
|sortorder|string/array|^|
|startSearch|boolean|^|

[comment]: # ({/6d7dd702-6102edd8})

[comment]: # ({7223bab1-2bc18eb2})
### Возвращаемые значения

`(integer/array)` Возвращает либо:

-   массив объектов;
-   количество полученных объектов, если использовался параметр `countOutput`.

[comment]: # ({/7223bab1-2bc18eb2})

[comment]: # ({b41637d2-802b3dd1})
### Примеры

[comment]: # ({/b41637d2-802b3dd1})

[comment]: # ({3ca44c43-c32b9462})
#### Получение данных по имени

Получить все данные о двух группах шаблонов с именами "Templates/Databases" и
"Templates/Modules".

[Запрос](/manual/api#performing-requests):

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

Ответ:

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

[comment]: # ({/3ca44c43-c32b9462})

[comment]: # ({f3cd9368-585b4960})
### См. также

-   [Шаблон](/manual/api/reference/template/object#template)

[comment]: # ({/f3cd9368-585b4960})

[comment]: # ({9f94aa1e-31239fd5})
### Источник

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

[comment]: # ({/9f94aa1e-31239fd5})