module.get

Опис

integer/array module.get(object parameters)

Метода омогућава преузимање модула према датим параметрима.

Ова метода је доступна само кориснику типа Супер администратор. Дозволе за позивање методе могу се опозвати у подешавањима корисничке улоге. Више информација потражите у одељку Корисничке улоге.

Параметри

(object) Параметри који дефинишу жељени излаз.

Метод подржава следеће параметре.

Parameter Type Description
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.