Zabbix Documentation 1.8

3.04.04.4 (current)| In development:5.0 (devel)| Unsupported:1.82.02.22.43.23.44.2Guidelines

User Tools

Site Tools


Sidebar

api:screen:get

Table of Contents

get()

Available since version: 1.8
This function allows you to retrieve Screen details based on filtering options. All parameters are optional. If parameter is set in query this option counted as ON, except if parameter is equal to NULL.

Parameters

ParameterTypeDescriptionDetails
nodeidsarrayNode IDs
screenidsarrayScreen IDs
screenitemidsarrayScreen item IDs
typeintegerScreen type
editableintegeronly with read-write permission. Ignored for SuperAdmins
filterarrayOptional filter by screen fields
searcharrayReturn screens by any given object field pattern
startSearchintegerSearch screens field pattern only in start of the field
excludeSearchintegerExclude from result, screens by given field pattern
searchWildcardsEnabledintegerSearch pattern in whole field using wildcards 1 - enable, 0 - disable
outputstringOutput options Values: shorten, refer, extend
select_screenitemsstringSelect screen items Values: shorten, refer, extend
countOutputintegerCount screens, return the number of screens found
preservekeysintegerReturn hash instead of array Keys of hash are object IDs
sortfieldstringSort by Screen field Values: screenid, name
sortorderstringSort order Values: ASC, DESC
limitintegermax number of screen objects to return

Returns

ParameterDescription
resultOperation successful. Result will contain array of Screen objects.
errorIn case of any errors

Example

Get screens details by screen name pattern “zabbix”:

{
"jsonrpc":"2.0",
"method":"screen.get",
"params":{
	"search": {"name": "zabbix"},
	"output": "extend"
},
"auth":"6f38cddc44cfbb6c1bd186f9a220b5a0",
"id":2
}

Retrieved screen details:

{
"jsonrpc":"2.0",
"result":[{
	"screenid":"100100000000002",
	"name":"Zabbix server",
	"hsize":"2",
	"vsize":"4"
},{
	"screenid":"100100000000007",
	"name":"ZABBIX",
	"hsize":"1",
	"vsize":"1"
}],
"id":2
}