Sidebar

manual:api:reference:service:update

service.update

Description

object service.update(object/array services)

This method allows to update existing services.

This method is only available to Admin and Super admin user types. Permissions to call the method can be revoked in user role settings. See User roles for more information.

Parameters

(object/array) service properties to be updated.

The serviceid property must be defined for each service, all other properties are optional. Only the passed properties will be updated, all others will remain unchanged.

Additionally to the standard service properties, the method accepts the following parameters.

Parameter Type Description
children array Child services to replace the current service children.

The children must have the serviceid property defined.
parents array Parent services to replace the current service parents.

The parents must have the serviceid property defined.
tags array Service tags to replace the current service tags.
times array Service times to replace the current service times.
problem_tags array Problem tags to replace the current problem tags.

Return values

(object) Returns an object containing the IDs of the updated services under the serviceids property.

Examples

Setting the parent for a service

Make service with ID “3” to be the parent for service with ID “5”.

Request:

{
    "jsonrpc": "2.0",
    "method": "service.update",
    "params": {
        "serviceid": "5",
        "parents": [
            {
                "serviceid": "3"
            }
        ]
    },
    "auth": "038e1d7b1735c6a5436ee9eae095879e",
    "id": 1
}

Response:

{
    "jsonrpc": "2.0",
    "result": {
        "serviceids": [
            "5"
        ]
    },
    "id": 1
}

Adding a scheduled downtime

Add a downtime for service with ID “4” scheduled weekly from Monday 22:00 till Tuesday 10:00.

Request:

{
    "jsonrpc": "2.0",
    "method": "service.update",
    "params": {
        "serviceid": "4",
        "times": [
            {
                "type": "1",
                "ts_from": "165600",
                "ts_to": "201600"
            }
        ]
    },
    "auth": "038e1d7b1735c6a5436ee9eae095879e",
    "id": 1
}

Response:

{
    "jsonrpc": "2.0",
    "result": {
        "serviceids": [
            "4"
        ]
    },
    "id": 1
}

Source

CService::update() in ui/include/classes/api/services/CService.php.