Отримати резервну копію за ідентифікатором

GET 
/backups/:id

<.backups.get.byid.description

Request

Path Parameters

id integerrequired

Ідентифікаційний номер резервної копії

Responses

200

Існує резервна копія

application/json

Schema

Schema

successbooleanrequired

Прапорець, який показує, чи був запит успішним

idinteger
Резервний ідентифікатор
Example: 1
namestring
Користувач визначив назву резервної копії
Example: backup
descriptionstring
Користувацький опис резервної копії
Example: backup description
controller_namestring
Ім'я контролера на момент створення резервної копії
Example: Sweet Home
controller_versionstring
Версія контролера на момент створення резервної копії.
Example: 0.9.22
brokenboolean
Прапорець, що вказує, чи є резервний файл пошкодженим
Example: false
serial_numberstring
Оригінальний серійний номер контролера
Example: 123456
creation_timeinteger
Час створення резервної копії (штамп Unix)
Example: 1612345678
sectionsinteger
Кількість розділів у резервній копії
Example: 2
roomsinteger
Кількість кімнат у резервній копії
Example: 3
devicesinteger
Кількість пристроїв у резервній копії
Example: 123
nodesinteger
Кількість вузлів Z-Wave у резервному копіюванні.
Example: 50
filenamestring
Ім'я файлу резервної копії
Example: backup_2024.01.01.cia
fullboolean
[TBD]
Example: true
dbginteger
[TBD]
Example: 0

Example (from schema)

{
  "success": true,
  "id": 1,
  "name": "backup",
  "description": "backup description",
  "controller_name": "Sweet Home",
  "controller_version": "0.9.22",
  "broken": false,
  "serial_number": "123456",
  "creation_time": 1612345678,
  "sections": 2,
  "rooms": 3,
  "devices": 123,
  "nodes": 50,
  "filename": "backup_2024.01.01.cia",
  "full": true,
  "dbg": 0
}

401

Користувач не має дозволу.

application/json

Schema

Schema

successbooleanrequired

Прапорець, який показує, чи був запит успішним

errorCodeintegerrequired

Ціле число помилки, див. Помилки

errorMessagestringrequired

Опис помилки

errorParameters

Додаткові дані, що описують помилку

Example (from schema)

{
  "success": true,
  "errorCode": 0,
  "errorMessage": "string"
}

Example

{
  "success": false,
  "errorCode": 4131,
  "errorMessage": "User not authorized",
  "errorParameters": "Not authorized"
}

404

Резервне копіювання не знайдено

application/json

Schema

Schema

successbooleanrequired

Прапорець, який показує, чи був запит успішним

errorCodeintegerrequired

Ціле число помилки, див. Помилки

errorMessagestringrequired

Опис помилки

errorParameters

Додаткові дані, що описують помилку

Example (from schema)

{
  "success": true,
  "errorCode": 0,
  "errorMessage": "string"
}

Example

{
  "success": false,
  "errorCode": 4129,
  "errorMessage": "Object not found",
  "errorParameters": {
    "type": "backup",
    "id": 3
  }
}