graphitem.get

Descrição

integer/array graphitem.get(object parameters)

O método permite recuperar itens de gráficos de acordo com os parâmetros fornecidos.

Este método está disponível para usuários de qualquer tipo. As permissões para chamar o método podem ser revogadas nas configurações de função do usuário. Veja Funções de usuário para mais informações.

Parâmetros

(object) Parâmetros que definem a saída desejada.

O método suporta os seguintes parâmetros.

Parâmetro Tipo Descrição
graphids ID/array Retorna apenas os itens de gráfico que pertencem aos gráficos fornecidos.
itemids ID/array Retorna apenas os itens de gráfico com os IDs de item fornecidos.
type integer Retorna apenas os itens de gráfico com o tipo fornecido.

Consulte a página do objeto de item de gráfico para uma lista dos tipos de itens de gráfico suportados.
selectGraphs query Retorna uma propriedade graphs com um array de gráficos aos quais o item pertence.
sortfield string/array Classifica o resultado pelas propriedades fornecidas.

Valores possíveis: gitemid.
countOutput boolean Esses parâmetros são descritos no comentário de referência.
editable boolean
limit integer
output query
preservekeys boolean
sortorder string/array

Valores de retorno

(integer/array) Retorna:

  • uma matriz de objetos;
  • a contagem de objetos recuperados, se o parâmetro countOutput tiver sido usado.

Exemplos

Recuperando itens de gráfico de um gráfico

Recupere todos os itens de gráfico usados em um gráfico com informações adicionais sobre o item e o host.

Requisição:

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

Resposta:

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

Veja também

Fonte

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