templatescreen.update
Description
object templatescreen.update(object/array **templateScreens**)
This method allows to update existing template screens.
Parameters
(object/array)
Template screen properties to be updated.
The screenid
property must be defined for each template screen, all other properties are optional. Only the passed properties will be updated, all others will remain unchanged.
Additionally to the standard template screen properties, the method accepts the following parameters.
Parameter | Type | Description |
---|---|---|
screenitems | array | Template screen items to replace existing screen items. Screen items are updated by coordinates, so each screen item must have the x and y properties defined. |
Return values
(object)
Returns an object containing the IDs of the updated template screens under the screenids
property.
Examples
Rename a template screen
Rename the template screen to “Performance graphs”.
Request:
{
"jsonrpc": "2.0",
"method": "templatescreen.update",
"params": {
"screenid": "3",
"name": "Performance graphs"
},
"auth": "038e1d7b1735c6a5436ee9eae095879e",
"id": 1
}
Response:
{
"jsonrpc": "2.0",
"result": {
"screenids": [
"3"
]
},
"id": 1
}
Source
CTemplateScreen::update() in ui/include/classes/api/services/CTemplateScreen.php.