graphitem.get

Opis

integer/array graphitem.get(object parameters)

Ta metoda umożliwia pobieranie elementów wykresu zgodnie z podanymi parametrami.

Ta metoda jest dostępna dla użytkowników każdego typu. Uprawnienia do wywoływania tej metody mogą zostać cofnięte w ustawieniach roli użytkownika. Więcej informacji można znaleźć w Rolach użytkowników.

Parametry

(object) Parametry definiujące żądane dane wyjściowe.

Metoda obsługuje następujące parametry.

Parametr Typ Opis
graphids ID/array Zwraca tylko pozycje wykresu należące do podanych wykresów.
itemids ID/array Zwraca tylko pozycje wykresu o podanych identyfikatorach pozycji.
type integer Zwraca tylko pozycje wykresu o podanym typie.

Listę obsługiwanych typów pozycji wykresu można znaleźć na stronie obiektu pozycji wykresu.
selectGraphs query Zwraca właściwość graphs zawierającą tablicę wykresów, do których należy pozycja.
sortfield string/array Sortuje wynik według podanych właściwości.

Możliwe wartości: gitemid.
countOutput boolean Te parametry opisano w komentarzu referencyjnym.
editable boolean
limit integer
output query
preservekeys boolean
sortorder string/array

Zwracane wartości

(integer/array) Zwraca:

  • tablicę obiektów;
  • liczbę pobranych obiektów, jeśli został użyty parametr countOutput.

Przykłady

Pobieranie pozycji wykresu z wykresu

Pobierz wszystkie pozycje wykresu używane na wykresie wraz z dodatkowymi informacjami o pozycji i hoście.

Żądanie:

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

Odpowiedź:

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

Zobacz także

Źródło

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