templatescreen.exists

Description

boolean templatescreen.exists(object filter)

This method checks if at least one template screen that matches the given filter criteria exists.

Parameters

(object) Criteria to search by.

The following parameters are supported as search criteria.

Parameter	Type	Description
name	string/array	Names of the screens.
node	string	Name of the node the template screens must belong to. This will override the `nodeids` parameter.
nodeids	string/array	IDs of the nodes the template screens must belong to.
screenid	string/array	IDs of the screens.
templateids	string/array	IDs of the templates that the screens belong to

Return values

(boolean) Returns true if at least one template screen that matches the given filter criteria exists.

Examples

Check screen by name

Check if screen "Zabbix server health" exists on template "10047".

Request:

{
           "jsonrpc": "2.0",
           "method": "templatescreen.exists",
           "params": {
               "name": "Zabbix server health",
               "templateid": "10047"
           },
           "auth": "3a57200802b24cda67c4e4010b50c065",
           "id": 1
       }

Response:

{
           "jsonrpc": "2.0",
           "result": true,
           "id": 1
       }

Source

CTemplateScreen::exists() in frontends/php/api/classes/CTemplateScreen.php.

Documentation