graphitem.get

Описание

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

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

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

Параметры

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

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

Параметр Тип Описание
graphids ID/array Возвращать только элементы графиков, принадлежащие указанным графикам.
itemids ID/array Возвращать только элементы графиков с указанными ID элементов данных.
type integer Возвращать только элементы графиков указанного типа.

Список поддерживаемых типов элементов графиков см. на странице объекта элемента графика.
selectGraphs query Возвращать свойство graphs с массивом графиков, к которым принадлежит элемент данных.
sortfield string/array Сортировать результат по указанным свойствам.

Возможные значения: gitemid.
countOutput boolean Эти параметры описаны в справочном комментарии.
editable boolean
limit integer
output query
preservekeys boolean
sortorder string/array

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

(целое число/массив) Возвращает либо:

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

Примеры

Получение элементов графика из графика

Получите все элементы графика, используемые в графике, с дополнительной информацией об элементе данных и узле сети.

Запрос:

{
    "jsonrpc": "2.0",
    "method": "graphitem.get",
    "params": {
        "output": "extend",
        "graphids": "387"
    },
    "id": 1
}

Ответ:

{
    "jsonrpc": "2.0",
    "result": [
        {
            "gitemid": "1242",
            "graphid": "387",
            "itemid": "22665",
            "drawtype": "1",
            "sortorder": "1",
            "color": "FF5555",
            "yaxisside": "0",
            "calc_fnc": "2",
            "type": "0"
        },
        {
            "gitemid": "1243",
            "graphid": "387",
            "itemid": "22668",
            "drawtype": "1",
            "sortorder": "2",
            "color": "55FF55",
            "yaxisside": "0",
            "calc_fnc": "2",
            "type": "0"
        },
        {
            "gitemid": "1244",
            "graphid": "387",
            "itemid": "22671",
            "drawtype": "1",
            "sortorder": "3",
            "color": "009999",
            "yaxisside": "0",
            "calc_fnc": "2",
            "type": "0"
        }
    ],
    "id": 1
}

Смотрите также

Источник

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