graphitem.get

Opis

integer/array graphitem.get(object parameters)

Metoda pozwala na pobranie pozycji wykresu zgodnie z podanymi parametrami.

Ta metoda jest dostępna dla użytkowników dowolnego typu. Uprawnienia do wywoływania metody można odebrać w ustawieniach roli użytkownika. Zobacz Role użytkownika po więcej informacji.

Parametry

(object) Parametry definiujące żądany wynik.

Metoda obsługuje następujące parametry.

Parametr Typ Opis
graphids string/array Zwraca tylko te pozycje wykresu, które należą do podanych wykresów.
itemids string/array Zwraca tylko pozycje wykresu z podanymi ID pozycji.
type integer Zwraca tylko pozycje wykresu o podanym typie.

Przejdź na stronę obiektu pozycji wykresu, aby uzyskać listę obsługiwanych typów pozycji wykresu.
selectGraphs query Zwraca właściwość graphs z tablicą wykresów, do których należy pozycja.
sortfield string/array Sortuj wynik według podanych właściwości.

Możliwe wartości to: gitemid.
countOutput boolean Te parametry wspólne dla wszystkich metod get zostały opisane w komentarzu referencyjnym.
editable boolean
limit integer
output query
preservekeys boolean
sortorder string/array

Zwracane wartości

(integer/array) Zwraca jedną z opcji:

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

Przykłady

Pobieranie pozycji wykresu z wykresu

Pobiera wszystkie pozycje wykresu użyte na wykresie z dodatkowymi informacjami o pozycji i hoście.

Zapytanie:

{
    "jsonrpc": "2.0",
    "method": "graphitem.get",
    "params": {
        "output": "extend",
        "graphids": "387"
    },
    "auth": "038e1d7b1735c6a5436ee9eae095879e",
    "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.