graphitem.get

Descripción

integer/array graphitem.get(object parameters)

El método permite recuperar elementos del gráfico de acuerdo con los parámetros suministrados.

Este método está disponible para usuarios de cualquier tipo. Los permisos para llamar al método se pueden revocar en la configuración de roles de usuario. Ver Roles de usuario para más información.

Parámetros

(objeto) Parámetros que definen la salida deseada.

El método admite los siguientes parámetros.

Parámetro Tipo Descripción
graphids cadena/matriz Devuelve solo elementos de gráfico que pertenecen a los gráficos dados.
itemids cadena/matriz Devuelve solo métricas del gráfico con los ID de métrica proporcionados.
type entero Devuelve solo elementos de gráficos con el tipo dado.

Consulte la página de objetos de elementos de gráficos para obtener una lista de los tipos de elementos de gráficos admitidos.
selectGraphs query Devuelve una propiedad graphs con una matriz de gráficos a los que pertenece el elemento.
sortfield cadena/matriz Ordena el resultado según las propiedades dadas.

Valores posibles: gitemid.
countOutput booleano Estos parámetros, que son comunes para todos los métodos get, se describen en detalle en la página comentario de referencia.
editable booleano
limit entero
output consulta
preservekeys booleano
sortorder cadena/matriz

Valores de retorno

(entero/matriz) Devuelve:

  • una matriz de objetos;
  • el recuento de objetos recuperados, si el parámetro countOutput ha sido usado.

Ejemplos

Recuperar métricas de gráfico de un gráfico

Recuperar todas las métricas de gráfico utilizadas en un gráfico con información adicional sobre la métrica y el equipo.

Solicitud:

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

Respuesta:

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

Ver también

Fuente

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