Breadcrumbs

Создание приватной папки

Приватные папки можно создавать только для дерева камер.

Они нужны для разграничения доступа к камерам в рамках одного элемента дерева.

Создавать папки можно только в конечном элементе дерева.

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




POST/api/v1/billing/tree/folders/private

Headers

Accept

application/json

Body

json
JSON
{
    "key": "random_key",
    "external_id": "external_id_of_tree_element",
    "id": null
}

keyrequired

string

Ключ для папки, который можно будет прислать вместо id при создании камеры, если нужно добавить камеру в папку

external_idrequired

string|int

Ключ для элемента дерева в котором нужно создать папку

idrequired

int

ID элемента дерева в котором нужно создать папку

Response




201

Успешный ответ
JSON
{
                "id": 15,
                "key": "random_key"
            }




422

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

Пример
JSON
curl -k --location --request POST 'https://vms.local/api/v1/billing/tree/folders/private' \
--header 'Accept:application/json' \
--header 'Content-Type: application/json \
--data-raw '{
    "key": "random_key",
    "external_id": "external_id_of_tree_element",
    "id": null
}'