[comment]: # ({63f61bee-1c702cf9})
# module.get

[comment]: # ({/63f61bee-1c702cf9})

[comment]: # ({88be7749-55f8403c})
### Описание

`integer/array module.get(object parameters)`

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

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

[comment]: # ({/88be7749-55f8403c})

[comment]: # ({79220f05-c81b6507})
### Параметры

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

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

|Parameter|[Type](/manual/api/reference_commentary#data-types)|Description|
|--|--|------|
|moduleids|ID/array|Возвращать только модули с указанными ID.|
|sortfield|string/array|Сортировать результат по указанным свойствам.<br><br>Возможные значения: `moduleid`, `relative_path`.|
|countOutput|boolean|Эти параметры описаны в [Reference commentary](/manual/api/reference_commentary#common-get-method-parameters).|
|excludeSearch|boolean|^|
|filter|object|^|
|limit|integer|^|
|output|query|^|
|preservekeys|boolean|^|
|search|object|^|
|searchByAny|boolean|^|
|searchWildcardsEnabled|boolean|^|
|sortorder|string/array|^|
|startSearch|boolean|^|

[comment]: # ({/79220f05-c81b6507})

[comment]: # ({07ca11ca-46698515})
### Возвращаемые значения

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

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

[comment]: # ({/07ca11ca-46698515})

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

[comment]: # ({/b41637d2-0d9fe9e7})

[comment]: # ({b4a4b966-8cbe68b4})
#### Получение модуля по ID

Получить все данные о модулях "1", "2" и "25".

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

```json
{
    "jsonrpc": "2.0",
    "method": "module.get",
    "params": {
        "output": "extend",
        "moduleids": [
            "1",
            "2",
            "25"
        ]
    },
    "id": 1
}
```

Ответ:

```json
{
    "jsonrpc": "2.0",
    "result": [
        {
            "moduleid": "1",
            "id": "actionlog",
            "relative_path": "widgets/actionlog",
            "status": "1",
            "config": []
        },
        {
            "moduleid": "2",
            "id": "clock",
            "relative_path": "widgets/clock",
            "status": "1",
            "config": []
        },
        {
            "moduleid": "25",
            "id": "example",
            "relative_path": "modules/example_module",
            "status": "1",
            "config": []
        }
    ],
    "id": 1
}
```

[comment]: # ({/b4a4b966-8cbe68b4})

[comment]: # ({393f0c8a-77300f42})
### См. также

-   [Модуль](object#module)
-   [Виджет панели мониторинга](/manual/api/reference/dashboard/object#dashboard-widget)
-   [Модули веб-интерфейса](/manual/extensions/frontendmodules)

[comment]: # ({/393f0c8a-77300f42})

[comment]: # ({397c2807-c9c85790})
### Источник

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

[comment]: # ({/397c2807-c9c85790})