module.get

Описание

integer/array module.get(object parameters)

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

Этот метод доступен только для пользователей типа Супер-администратор. Разрешения на вызов этого метода могут быть отозваны в настройках роли пользователя. Для получения дополнительной информации смотрите Роли пользователей.

Параметры

(object) Параметры, определяющие желаемый вывод.

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

Параметр Тип Описание
moduleids ID/array Возвращать только модули с указанными ID.
sortfield string/array Сортировать результат по указанным свойствам.

Возможные значения: moduleid, relative_path.
countOutput boolean Эти параметры описаны в Справочном комментарии.
excludeSearch boolean
filter object
limit integer
output query
preservekeys boolean
search object
searchByAny boolean
searchWildcardsEnabled boolean
sortorder string/array
startSearch boolean

Возвращаемые значения

(integer/array) Возвращает одно из следующего:

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

Примеры

Получение модуля по ID

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

Запрос:

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

Ответ:

{
    "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
}

См. также

Исходный код

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