maintenance.exists

Description

boolean maintenance.exists(object filter)

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

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

Parameters

(object) Criteria to search by.

The following parameters are supported as search criteria.

Parameter Type Description
maintenanceid string/array IDs of the maintenances
name string/array Names of the maintenances

Return values

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

Examples

Checking maintenance by name

Check if maintenance with the name "Sunday maintenance" already exists.

Request:

{
    "jsonrpc": "2.0",
    "method": "maintenance.exists",
    "params": {
        "name": "Sunday maintenance"
    },
    "auth": "3a57200802b24cda67c4e4010b50c065",
    "id": 1
}

Response:

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

Source

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