Zabbix Documentation 2.4

2.23.04.04.2 (current)In development:4.4 (devel)Unsupported:1.82.02.43.23.4

User Tools

Site Tools


Sidebar

manual:api:reference:templatescreen:exists

templatescreen.exists

Description

boolean templatescreen.exists(object filter)

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

This method is deprecated and will be removed in the future. Please use templatescreen.get instead.

Parameters

(object) Criteria to search by.

The following parameters are supported as search criteria.

Parameter Type Description
name string/array Names of the screens.
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
}

See also

Source

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