graphitem.get

Descripció

integer/array graphitem.get(object parameters)

El mètode permet recuperar elements gràfics segons els paràmetres proveïts.

Aquest mètode és disponible per a usuaris de qualsevol mena. Els permisos per cridar al mètode es poden revocar a les configuracions de rols d'usuari. Per a més informació, veieu Rols d'usuari.

Paràmetres

(object) Paràmetres que defineixen la sortida esperada.

El mètode admet els paràmetres següents.

Paràmetre	Tipus	Descripció
graphids	string/array	Retorna només els elements de gràfic que pertanyen als gràfics donats.
itemids	string/array	Retorna només els elements del gràfic amb els ID d'elements donats.
type	integer	Retorna només els elements del gràfic amb el tipus donat. Consulteu la pàgina d'objectes d'elements de gràfic per obtindre una llista dels gràfics compatibles amb els tipus d'elements.
selectGraphs	query	Retorna una propietat gràfics que conté una matriu de gràfics a què pertany l'element.
sortfield	string/array	Ordena el resultat per les propietats donades. Els valors possibles són: `gitemid`.
countOutput	boolean	Aquests paràmetres són descrits a reference comments.
editable	boolean
limit	integer
output	query
preservekeys	boolean
sortorder	string/array

Valors de retorn

(integer/array) Retorna un d'entre:

una taula d'objectes;
el recompte d'objectes recuperats, si s'empra el paràmetre countOutput.

Exemples

Recuperar elements d'un gràfic específic

Recuperar tots els elements que empra un gràfic amb les informacions addicionals de l'element i de l'equip.

Petició:

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

Veieu també

Gràfic

Font

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

Documentation