Breadcrumbs

Обновление элемента дерева

При обновлении элемента дереве можно его переименовать или поменять ключ.

При изменении ключа, у элемента дерева не пропадают зависимости, которые были созданы через старый ключ.

Элемент дерева можно обновить по id или по external_id.




PATCH/api/v1/billing/tree

Headers

Accept

application/json

Body

json
JSON
{
    "name": "new name",
    "type": "cameras|intercoms",
    "id": null,
    "external_id": "current_value",
    "new_external_id": "new_value"
}

namerequired

string

Название элемента дерева

idrequired

int

Идентификатор элемента дерева, который нужно обновить

external_idrequired

string|int

Ключ для элемента дерева

typerequired

string

Тип дерева, в рамках которого происходит обновление

new_external_idrequired

string|int

Новый уникальный собственный ключ для элемента дерева

Response




200

Успешный ответ
JSON
{
                "id": 15,
                "name": "Name of item",
                "external_id": "unique_key",
                "has_items": true
            }




422

Возвращает JSON объект с ошибкой, см. Валидация
JSON
{
    "message": "Тут не будет информативного сообщения",
    "errors": {
        "any_key": [
            "Тут будет описана причина ошибки"
        ]
    }
}

Пример
JSON
curl -k --location --request PATCH 'https://vms.local/api/v1/billing/tree' \
--header 'Accept:application/json' \
--header 'Content-Type: application/json \
--data-raw '{
    "name": "new name",
    "type": "cameras|intercoms",
    "id": null,
    "external_id": "current_value",
    "new_external_id": "new_value"
}'