# Сервис видеозаписи

Данная модель описывает REST-API интерфейс сервиса видеозаписи

### [](#%D1%80%D0%B5%D1%81%D1%83%D1%80%D1%81%D1%8B-%D0%B2%D1%85%D0%BE%D0%B4%D1%8F%D1%89%D0%B8%D0%B5-%D0%BF%D0%BE%D1%82%D0%BE%D0%BA%D0%B8)Ресурсы (входящие потоки)

#### [](#%D0%BF%D0%BE%D0%BB%D1%83%D1%87%D0%B5%D0%BD%D0%B8%D0%B5-%D1%81%D0%BF%D0%B8%D1%81%D0%BA%D0%B0-%D1%80%D0%B5%D1%81%D1%83%D1%80%D1%81%D0%BE%D0%B2)Получение списка ресурсов

Строка запроса **GET**: /api/v1/source

##### [](#%D0%BF%D0%B0%D1%80%D0%B0%D0%BC%D0%B5%D1%82%D1%80%D1%8B-%D0%B7%D0%B0%D0%BF%D1%80%D0%BE%D1%81%D0%B0)Параметры запроса:

*Параметры отсутствуют*

##### [](#%D0%B2%D0%B0%D1%80%D0%B8%D0%B0%D0%BD%D1%82%D1%8B-%D0%BE%D1%82%D0%B2%D0%B5%D1%82%D0%B0)Варианты ответа:

**Успешно**

```
[
  {
    "id": "Идентификатор ресурса",
    "created_utc": "Дата-время создания ресурса",
    "status": "Состояние доступности ресурса",
    "uri_rtsp": "Адрес RTSP потока",
    "uri_http_picture": {
      "uri": "Адрес получения изображения",
      "auth": "basic или digest",
      "user": "Пользователь",
      "password": "Пароль"
    },
    "description": "Описание ресурса",
    "ffmpeg_cmd": "Шаблон команды транскодирования потока"
  }
]
```

#### [](#%D1%81%D0%BE%D0%B7%D0%B4%D0%B0%D0%BD%D0%B8%D0%B5-%D1%80%D0%B5%D1%81%D1%83%D1%80%D1%81%D0%B0)Создание ресурса

**POST**: /api/v1/source

##### [](#%D0%BF%D0%B0%D1%80%D0%B0%D0%BC%D0%B5%D1%82%D1%80%D1%8B-%D0%B7%D0%B0%D0%BF%D1%80%D0%BE%D1%81%D0%B0-1)Параметры запроса:

<table data-sourcepos="42:1-52:105" dir="auto" id="bkmrk-%D0%9F%D0%B0%D1%80%D0%B0%D0%BC%D0%B5%D1%82%D1%80-%D0%97%D0%BD%D0%B0%D1%87%D0%B5%D0%BD%D0%B8%D0%B5-%D0%9E%D0%BF"><thead><tr data-sourcepos="42:1-42:52"><th data-sourcepos="42:2-42:17">Параметр</th><th data-sourcepos="42:19-42:34">Значение</th><th data-sourcepos="42:36-42:51">Описание</th></tr></thead><tbody><tr data-sourcepos="44:1-44:90"><td data-sourcepos="44:2-44:10">**model**</td><td data-sourcepos="44:12-44:29">Текстовый</td><td data-sourcepos="44:31-44:89">Модель ресурса *Source* или *PictureSource*</td></tr><tr data-sourcepos="45:1-45:64"><td data-sourcepos="45:2-45:12">description</td><td data-sourcepos="45:14-45:31">Текстовый</td><td data-sourcepos="45:33-45:63">Описание ресурса</td></tr><tr data-sourcepos="46:1-46:60"><td data-sourcepos="46:2-46:13">**uri\_rtsp**</td><td data-sourcepos="46:15-46:30">Строка URI</td><td data-sourcepos="46:32-46:59">Адрес RTSP потока</td></tr><tr data-sourcepos="47:1-47:86"><td data-sourcepos="47:2-47:17">uri\_http\_picture</td><td data-sourcepos="47:19-47:36">Структура</td><td data-sourcepos="47:38-47:85">Описание скриншота камеры</td></tr><tr data-sourcepos="48:1-48:81"><td data-sourcepos="48:2-48:10"> uri</td><td data-sourcepos="48:12-48:27">Строка URI</td><td data-sourcepos="48:29-48:80">Адрес получения изображения</td></tr><tr data-sourcepos="49:1-49:61"><td data-sourcepos="49:2-49:11"> auth</td><td data-sourcepos="49:13-49:36">Перечисление</td><td data-sourcepos="49:38-49:60">*basic* или *digest*</td></tr><tr data-sourcepos="50:1-50:56"><td data-sourcepos="50:2-50:11"> user</td><td data-sourcepos="50:13-50:30">Текстовый</td><td data-sourcepos="50:32-50:55">Пользователь</td></tr><tr data-sourcepos="51:1-51:48"><td data-sourcepos="51:2-51:15"> password</td><td data-sourcepos="51:17-51:34">Текстовый</td><td data-sourcepos="51:36-51:47">Пароль</td></tr><tr data-sourcepos="52:1-52:105"><td data-sourcepos="52:2-52:11">ffmpeg\_cmd</td><td data-sourcepos="52:13-52:30">Текстовый</td><td data-sourcepos="52:32-52:104">Шаблон команды транскодирования потока</td></tr></tbody></table>

##### [](#%D0%B2%D0%B0%D1%80%D0%B8%D0%B0%D0%BD%D1%82%D1%8B-%D0%BE%D1%82%D0%B2%D0%B5%D1%82%D0%B0-1)Варианты ответа:

**Ошибка 422**

```
{
  "detail": [
    {
      "loc": ["Положение ошибки"],
      "msg": "Сообщение ошибки",
      "type": "Тип ошибки"
    }
  ]
}
```

**Успешно**

```
{
  "id": "Идентификатор ресурса",
  "created_utc": "Дата-время создания ресурса",
  "status": "Состояние доступности ресурса",
  "uri_rtsp": "Адрес RTSP потока",
  "uri_http_picture": {
    "uri": "Адрес получения изображения",
    "auth": "*basic* или *digest*",
    "user": "Пользователь",
    "password": "Пароль"
  },
  "description": "Описание ресурса",
  "ffmpeg_cmd": "Шаблон команды транскодирования потока"
}
```

#### [](#%D0%BF%D0%BE%D0%BB%D1%83%D1%87%D0%B5%D0%BD%D0%B8%D0%B5-%D1%80%D0%B5%D1%81%D1%83%D1%80%D1%81%D0%B0)Получение ресурса

**GET**: /api/v1/source/**{source\_id}**/

##### [](#%D0%BF%D0%B0%D1%80%D0%B0%D0%BC%D0%B5%D1%82%D1%80%D1%8B-%D0%B7%D0%B0%D0%BF%D1%80%D0%BE%D1%81%D0%B0-2)Параметры запроса:

<table data-sourcepos="92:1-94:100" dir="auto" id="bkmrk-%D0%9F%D0%B0%D1%80%D0%B0%D0%BC%D0%B5%D1%82%D1%80-%D0%97%D0%BD%D0%B0%D1%87%D0%B5%D0%BD%D0%B8%D0%B5-%D0%9E%D0%BF-1"><thead><tr data-sourcepos="92:1-92:52"><th data-sourcepos="92:2-92:17">Параметр</th><th data-sourcepos="92:19-92:34">Значение</th><th data-sourcepos="92:36-92:51">Описание</th></tr></thead><tbody><tr data-sourcepos="94:1-94:100"><td data-sourcepos="94:2-94:10">source\_id</td><td data-sourcepos="94:12-94:27">Числовой</td><td data-sourcepos="94:29-94:99">Идентификатор ресурса *(часть запроса)*</td></tr></tbody></table>

##### [](#%D0%B2%D0%B0%D1%80%D0%B8%D0%B0%D0%BD%D1%82%D1%8B-%D0%BE%D1%82%D0%B2%D0%B5%D1%82%D0%B0-2)Варианты ответа:

**Ошибка 422**

```
{
  "detail": [
    {
      "loc": ["Положение ошибки"],
      "msg": "Сообщение ошибки",
      "type": "Тип ошибки"
    }
  ]
}
```

**Успешно**

```
{
  "id": "Идентификатор ресурса",
  "created_utc": "Дата-время создания ресурса",
  "status": "Состояние доступности ресурса",
  "uri_rtsp": "Адрес RTSP потока",
  "uri_http_picture": {
    "uri": "Адрес получения изображения",
    "auth": "*basic* или *digest*",
    "user": "Пользователь",
    "password": "Пароль"
  },
  "description": "Описание ресурса",
  "ffmpeg_cmd": "Шаблон команды транскодирования потока"
}
```

#### [](#%D0%B8%D0%B7%D0%BC%D0%B5%D0%BD%D0%B5%D0%BD%D0%B8%D0%B5-%D1%80%D0%B5%D1%81%D1%83%D1%80%D1%81%D0%B0)Изменение ресурса

**PUT**: /api/v1/source/**{source\_id}**/

##### [](#%D0%BF%D0%B0%D1%80%D0%B0%D0%BC%D0%B5%D1%82%D1%80%D1%8B-%D0%B7%D0%B0%D0%BF%D1%80%D0%BE%D1%81%D0%B0-3)Параметры запроса:

<table data-sourcepos="134:1-145:105" dir="auto" id="bkmrk-%D0%9F%D0%B0%D1%80%D0%B0%D0%BC%D0%B5%D1%82%D1%80-%D0%97%D0%BD%D0%B0%D1%87%D0%B5%D0%BD%D0%B8%D0%B5-%D0%9E%D0%BF-2"><thead><tr data-sourcepos="134:1-134:52"><th data-sourcepos="134:2-134:17">Параметр</th><th data-sourcepos="134:19-134:34">Значение</th><th data-sourcepos="134:36-134:51">Описание</th></tr></thead><tbody><tr data-sourcepos="136:1-136:100"><td data-sourcepos="136:2-136:10">source\_id</td><td data-sourcepos="136:12-136:27">Числовой</td><td data-sourcepos="136:29-136:99">Идентификатор ресурса *(часть запроса)*</td></tr><tr data-sourcepos="137:1-137:54"><td data-sourcepos="137:2-137:6">model</td><td data-sourcepos="137:8-137:25">Текстовый</td><td data-sourcepos="137:27-137:53">Модель ресурса</td></tr><tr data-sourcepos="138:1-138:64"><td data-sourcepos="138:2-138:12">description</td><td data-sourcepos="138:14-138:31">Текстовый</td><td data-sourcepos="138:33-138:63">Описание ресурса</td></tr><tr data-sourcepos="139:1-139:55"><td data-sourcepos="139:2-139:9">uri\_rtsp</td><td data-sourcepos="139:11-139:26">Текствый</td><td data-sourcepos="139:28-139:55">Адрес RTSP потока</td></tr><tr data-sourcepos="140:1-140:43"><td data-sourcepos="140:2-140:18">uri\_http\_picture:</td><td data-sourcepos="140:20-140:41">Структура URI</td><td data-sourcepos="140:43-140:42"> </td></tr><tr data-sourcepos="141:1-141:83"><td data-sourcepos="141:2-141:10"> uri</td><td data-sourcepos="141:12-141:29">Тесктовый</td><td data-sourcepos="141:31-141:82">Адрес получения изображения</td></tr><tr data-sourcepos="142:1-142:55"><td data-sourcepos="142:2-142:11"> auth</td><td data-sourcepos="142:13-142:30">Текстовый</td><td data-sourcepos="142:32-142:54">*basic* или *digest*</td></tr><tr data-sourcepos="143:1-143:56"><td data-sourcepos="143:2-143:11"> user</td><td data-sourcepos="143:13-143:30">Текстовый</td><td data-sourcepos="143:32-143:55">Пользователь</td></tr><tr data-sourcepos="144:1-144:49"><td data-sourcepos="144:2-144:15"> password</td><td data-sourcepos="144:17-144:34">Текстовый</td><td data-sourcepos="144:36-144:48">Пароль</td></tr><tr data-sourcepos="145:1-145:105"><td data-sourcepos="145:2-145:11">ffmpeg\_cmd</td><td data-sourcepos="145:13-145:30">Текстовый</td><td data-sourcepos="145:32-145:104">Шаблон команды транскодирования потока</td></tr></tbody></table>

##### [](#%D0%B2%D0%B0%D1%80%D0%B8%D0%B0%D0%BD%D1%82%D1%8B-%D0%BE%D1%82%D0%B2%D0%B5%D1%82%D0%B0-3)Варианты ответа:

**Ошибка 422**

```
{
  "detail": [
    {
      "loc": ["Положение ошибки"],
      "msg": "Сообщение ошибки",
      "type": "Тип ошибки"
    }
  ]
}
```

**Успешно**

```
{
  "id": "Идентификатор ресурса",
  "created_utc": "Дата-время создания ресурса",
  "status": "Состояние доступности ресурса",
  "uri_rtsp": "Адрес RTSP потока",
  "uri_http_picture": {
    "uri": "Адрес получения изображения",
    "auth": "*basic* или *digest*",
    "user": "Пользователь",
    "password": "Пароль"
  },
  "description": "Описание ресурса",
  "ffmpeg_cmd": "Шаблон команды транскодирования потока"
}
```

#### [](#%D1%83%D0%B4%D0%B0%D0%BB%D0%B5%D0%BD%D0%B8%D0%B5-%D1%80%D0%B5%D1%81%D1%83%D1%80%D1%81%D0%B0)Удаление ресурса

**DELETE**: /api/v1/source/**{source\_id}**/

##### [](#%D0%BF%D0%B0%D1%80%D0%B0%D0%BC%D0%B5%D1%82%D1%80%D1%8B-%D0%B7%D0%B0%D0%BF%D1%80%D0%BE%D1%81%D0%B0-4)Параметры запроса:

<table data-sourcepos="185:1-187:100" dir="auto" id="bkmrk-%D0%9F%D0%B0%D1%80%D0%B0%D0%BC%D0%B5%D1%82%D1%80-%D0%97%D0%BD%D0%B0%D1%87%D0%B5%D0%BD%D0%B8%D0%B5-%D0%9E%D0%BF-3"><thead><tr data-sourcepos="185:1-185:52"><th data-sourcepos="185:2-185:17">Параметр</th><th data-sourcepos="185:19-185:34">Значение</th><th data-sourcepos="185:36-185:51">Описание</th></tr></thead><tbody><tr data-sourcepos="187:1-187:100"><td data-sourcepos="187:2-187:10">source\_id</td><td data-sourcepos="187:12-187:27">Числовой</td><td data-sourcepos="187:29-187:99">Идентификатор ресурса *(часть запроса)*</td></tr></tbody></table>

##### [](#%D0%B2%D0%B0%D1%80%D0%B8%D0%B0%D0%BD%D1%82%D1%8B-%D0%BE%D1%82%D0%B2%D0%B5%D1%82%D0%B0-4)Варианты ответа:

**Ошибка 422**

```
{
  "detail": [
    {
      "loc": ["Положение ошибки"],
      "msg": "Сообщение ошибки",
      "type": "Тип ошибки"
    }
  ]
}
```

**Успешно**

```
{
  "id": "Идентификатор ресурса",
  "created_utc": "Дата-время создания ресурса",
  "status": "Состояние доступности ресурса",
  "uri_rtsp": "Адрес RTSP потока",
  "uri_http_picture": {
    "uri": "Адрес получения изображения",
    "auth": "*basic* или *digest*",
    "user": "Пользователь",
    "password": "Пароль"
  },
  "description": "Описание ресурса",
  "ffmpeg_cmd": "Шаблон команды транскодирования потока"
}
```

#### [](#%D0%BF%D0%BE%D0%BB%D1%83%D1%87%D0%B5%D0%BD%D0%B8%D0%B5-%D1%81%D0%BA%D1%80%D0%B8%D0%BD%D1%88%D0%BE%D1%82%D0%B0-%D0%BF%D0%BE%D1%82%D0%BE%D0%BA%D0%B0)Получение скриншота потока

Строка запроса **GET**: /api/v1/source/**{source\_id}**/picture

##### [](#%D0%BF%D0%B0%D1%80%D0%B0%D0%BC%D0%B5%D1%82%D1%80%D1%8B-%D0%B7%D0%B0%D0%BF%D1%80%D0%BE%D1%81%D0%B0-5)Параметры запроса:

<table data-sourcepos="228:1-230:100" dir="auto" id="bkmrk-%D0%9F%D0%B0%D1%80%D0%B0%D0%BC%D0%B5%D1%82%D1%80-%D0%97%D0%BD%D0%B0%D1%87%D0%B5%D0%BD%D0%B8%D0%B5-%D0%9E%D0%BF-4"><thead><tr data-sourcepos="228:1-228:52"><th data-sourcepos="228:2-228:17">Параметр</th><th data-sourcepos="228:19-228:34">Значение</th><th data-sourcepos="228:36-228:51">Описание</th></tr></thead><tbody><tr data-sourcepos="230:1-230:100"><td data-sourcepos="230:2-230:10">source\_id</td><td data-sourcepos="230:12-230:27">Числовой</td><td data-sourcepos="230:29-230:99">Идентификатор ресурса *(часть запроса)*</td></tr></tbody></table>

##### [](#%D0%B2%D0%B0%D1%80%D0%B8%D0%B0%D0%BD%D1%82%D1%8B-%D0%BE%D1%82%D0%B2%D0%B5%D1%82%D0%B0-5)Варианты ответа:

**Ошибка 422**

```
{
  "detail": [
    {
      "loc": ["Положение ошибки"],
      "msg": "Сообщение ошибки",
      "type": "Тип ошибки"
    }
  ]
}
```

**Успешно** *Данные изображения*

#### [](#%D0%BF%D0%BE%D0%BB%D1%83%D1%87%D0%B5%D0%BD%D0%B8%D0%B5-%D1%81%D0%BA%D1%80%D0%B8%D0%BD%D1%88%D0%BE%D1%82%D0%B0-%D0%BF%D0%BE%D1%82%D0%BE%D0%BA%D0%B0-1)Получение скриншота потока

Строка запроса **GET**: /api/v1/source/**{source\_id}**/video

##### [](#%D0%BF%D0%B0%D1%80%D0%B0%D0%BC%D0%B5%D1%82%D1%80%D1%8B-%D0%B7%D0%B0%D0%BF%D1%80%D0%BE%D1%81%D0%B0-6)Параметры запроса:

<table data-sourcepos="256:1-259:129" dir="auto" id="bkmrk-%D0%9F%D0%B0%D1%80%D0%B0%D0%BC%D0%B5%D1%82%D1%80-%D0%97%D0%BD%D0%B0%D1%87%D0%B5%D0%BD%D0%B8%D0%B5-%D0%9E%D0%BF-5"><thead><tr data-sourcepos="256:1-256:52"><th data-sourcepos="256:2-256:17">Параметр</th><th data-sourcepos="256:19-256:34">Значение</th><th data-sourcepos="256:36-256:51">Описание</th></tr></thead><tbody><tr data-sourcepos="258:1-258:100"><td data-sourcepos="258:2-258:10">source\_id</td><td data-sourcepos="258:12-258:27">Числовой</td><td data-sourcepos="258:29-258:99">Идентификатор ресурса *(часть запроса)*</td></tr><tr data-sourcepos="259:1-259:129"><td data-sourcepos="259:2-259:6">delay</td><td data-sourcepos="259:8-259:23">Числовой</td><td data-sourcepos="259:25-259:128">Задержка между кадрами в секундах, по умолчанию 1 секунда</td></tr></tbody></table>

##### [](#%D0%B2%D0%B0%D1%80%D0%B8%D0%B0%D0%BD%D1%82%D1%8B-%D0%BE%D1%82%D0%B2%D0%B5%D1%82%D0%B0-6)Варианты ответа:

**Ошибка 422**

```
{
  "detail": [
    {
      "loc": ["Положение ошибки"],
      "msg": "Сообщение ошибки",
      "type": "Тип ошибки"
    }
  ]
}
```

**Успешно** *Данные видеопотока mJPEG*

### [](#%D1%83%D0%BF%D1%80%D0%B0%D0%B2%D0%BB%D0%B5%D0%BD%D0%B8%D0%B5-%D0%B7%D0%B0%D0%BF%D0%B8%D1%81%D1%8C%D1%8E)Управление записью

#### [](#%D0%BF%D0%BE%D0%BB%D1%83%D1%87%D0%B5%D0%BD%D0%B8%D0%B5-%D1%81%D0%BE%D1%81%D1%82%D0%BE%D1%8F%D0%BD%D0%B8%D1%8F-%D0%B7%D0%B0%D0%BF%D0%B8%D1%81%D0%B8-%D1%80%D0%B5%D1%81%D1%83%D1%80%D1%81%D0%BE%D0%B2-%D0%BF%D0%BE-%D0%BC%D0%B5%D1%82%D0%BA%D0%B5)Получение состояния записи ресурсов по метке

Строка запроса **GET**: /api/v1/record

##### [](#%D0%BF%D0%B0%D1%80%D0%B0%D0%BC%D0%B5%D1%82%D1%80%D1%8B-%D0%B7%D0%B0%D0%BF%D1%80%D0%BE%D1%81%D0%B0-7)Параметры запроса:

<table data-sourcepos="287:1-289:84" dir="auto" id="bkmrk-%D0%9F%D0%B0%D1%80%D0%B0%D0%BC%D0%B5%D1%82%D1%80-%D0%97%D0%BD%D0%B0%D1%87%D0%B5%D0%BD%D0%B8%D0%B5-%D0%9E%D0%BF-6"><thead><tr data-sourcepos="287:1-287:52"><th data-sourcepos="287:2-287:17">Параметр</th><th data-sourcepos="287:19-287:34">Значение</th><th data-sourcepos="287:36-287:51">Описание</th></tr></thead><tbody><tr data-sourcepos="289:1-289:84"><td data-sourcepos="289:2-289:9">tag\_name</td><td data-sourcepos="289:11-289:28">Текстовый</td><td data-sourcepos="289:30-289:83">Идентификатор метки ресурсов</td></tr></tbody></table>

##### [](#%D0%B2%D0%B0%D1%80%D0%B8%D0%B0%D0%BD%D1%82%D1%8B-%D0%BE%D1%82%D0%B2%D0%B5%D1%82%D0%B0-7)Варианты ответа:

**Ошибка 422**

```
{
  "detail": [
    {
      "loc": ["Положение ошибки"],
      "msg": "Сообщение ошибки",
      "type": "Тип ошибки"
    }
  ]
}
```

**Успешно**

```
[
  {
    "id": "Идентификатор записи",
    "created_utc": "Дата-время создания записи",
    "status": "Состояние записи",
    "begin_utc": "Дата-время начала записи",
    "end_utc": "Дата-время окончания записи",
    "source": [
      {
        "id": "Идентификатор ресурса",
        "created_utc": "Дата-время создания ресурса",
        "status": "Состояние доступности ресурса",
        "uri_rtsp": "Адрес RTSP потока",
        "uri_http_picture": {
          "uri": "Адрес получения изображения",
          "auth": "*basic* или *digest*",
          "user": "Пользователь",
          "password": "Пароль"
        },
        "description": "Описание ресурса",
        "ffmpeg_cmd": "Шаблон команды транскодирования потока"
      }
    ],
    "hash_md5": "Контрольная сумма записи MD5",
    "location": "Путь хранения записи",
    "sync_location": "Пусть для синхронизации видеозаписи с другим видеосервером"
  }
]
```

#### [](#%D0%BE%D1%81%D1%82%D0%B0%D0%BD%D0%BE%D0%B2%D0%BA%D0%B0-%D0%B7%D0%B0%D0%BF%D0%B8%D1%81%D0%B8-%D0%B3%D1%80%D1%83%D0%BF%D0%BF%D1%8B-%D1%80%D0%B5%D1%81%D1%83%D1%80%D1%81%D0%BE%D0%B2-%D0%BF%D0%BE-%D0%B8%D0%B4%D0%B5%D0%BD%D1%82%D0%B8%D1%84%D0%B8%D0%BA%D0%B0%D1%82%D0%BE%D1%80%D1%83-%D0%BC%D0%B5%D1%82%D0%BA%D0%B8)Остановка записи группы ресурсов по идентификатору метки

**PUT**: /api/v1/record

##### [](#%D0%BF%D0%B0%D1%80%D0%B0%D0%BC%D0%B5%D1%82%D1%80%D1%8B-%D0%B7%D0%B0%D0%BF%D1%80%D0%BE%D1%81%D0%B0-8)Параметры запроса:

<table data-sourcepos="343:1-346:84" dir="auto" id="bkmrk-%D0%9F%D0%B0%D1%80%D0%B0%D0%BC%D0%B5%D1%82%D1%80-%D0%97%D0%BD%D0%B0%D1%87%D0%B5%D0%BD%D0%B8%D0%B5-%D0%9E%D0%BF-7"><thead><tr data-sourcepos="343:1-343:52"><th data-sourcepos="343:2-343:17">Параметр</th><th data-sourcepos="343:19-343:34">Значение</th><th data-sourcepos="343:36-343:51">Описание</th></tr></thead><tbody><tr data-sourcepos="345:1-345:136"><td data-sourcepos="345:2-345:6">model</td><td data-sourcepos="345:8-345:25">Текстовый</td><td data-sourcepos="345:27-345:135">Модель метки записи ресурса для изменений *Source* или *PictureSource*</td></tr><tr data-sourcepos="346:1-346:84"><td data-sourcepos="346:2-346:9">tag\_name</td><td data-sourcepos="346:11-346:28">Текстовый</td><td data-sourcepos="346:30-346:83">Идентификатор метки ресурсов</td></tr></tbody></table>

##### [](#%D0%B2%D0%B0%D1%80%D0%B8%D0%B0%D0%BD%D1%82%D1%8B-%D0%BE%D1%82%D0%B2%D0%B5%D1%82%D0%B0-8)Варианты ответа:

**Ошибка 422**

```
{
  "detail": [
    {
      "loc": ["Положение ошибки"],
      "msg": "Сообщение ошибки",
      "type": "Тип ошибки"
    }
  ]
}
```

**Успешно** *Нет данных*

#### [](#%D0%B7%D0%B0%D0%BF%D1%83%D1%81%D0%BA-%D0%B7%D0%B0%D0%BF%D0%B8%D1%81%D0%B8-%D0%B3%D1%80%D1%83%D0%BF%D0%BF%D1%8B-%D1%80%D0%B5%D1%81%D1%83%D1%80%D1%81%D0%BE%D0%B2-%D1%81-%D0%BC%D0%B5%D1%82%D0%BA%D0%BE%D0%B9)Запуск записи группы ресурсов с меткой

**POST**: /api/v1/record

##### [](#%D0%BF%D0%B0%D1%80%D0%B0%D0%BC%D0%B5%D1%82%D1%80%D1%8B-%D0%B7%D0%B0%D0%BF%D1%80%D0%BE%D1%81%D0%B0-9)Параметры запроса:

<table data-sourcepos="371:1-375:88" dir="auto" id="bkmrk-%D0%9F%D0%B0%D1%80%D0%B0%D0%BC%D0%B5%D1%82%D1%80-%D0%97%D0%BD%D0%B0%D1%87%D0%B5%D0%BD%D0%B8%D0%B5-%D0%9E%D0%BF-8"><thead><tr data-sourcepos="371:1-371:52"><th data-sourcepos="371:2-371:17">Параметр</th><th data-sourcepos="371:19-371:34">Значение</th><th data-sourcepos="371:36-371:51">Описание</th></tr></thead><tbody><tr data-sourcepos="373:1-373:136"><td data-sourcepos="373:2-373:6">model</td><td data-sourcepos="373:8-373:25">Текстовый</td><td data-sourcepos="373:27-373:135">Модель метки записи ресурса для изменений *Source* или *PictureSource*</td></tr><tr data-sourcepos="374:1-374:84"><td data-sourcepos="374:2-374:9">tag\_name</td><td data-sourcepos="374:11-374:28">Текстовый</td><td data-sourcepos="374:30-374:83">Идентификатор метки ресурсов</td></tr><tr data-sourcepos="375:1-375:88"><td data-sourcepos="375:2-375:11">group\_name</td><td data-sourcepos="375:13-375:30">Текстовый</td><td data-sourcepos="375:32-375:87">Идентификатор группы ресурсов</td></tr></tbody></table>

##### [](#%D0%B2%D0%B0%D1%80%D0%B8%D0%B0%D0%BD%D1%82%D1%8B-%D0%BE%D1%82%D0%B2%D0%B5%D1%82%D0%B0-9)Варианты ответа:

**Ошибка 422**

```
{
  "detail": [
    {
      "loc": ["Положение ошибки"],
      "msg": "Сообщение ошибки",
      "type": "Тип ошибки"
    }
  ]
}
```

**Успешно** *Нет данных*

#### [](#%D0%BF%D0%BE%D0%BB%D1%83%D1%87%D0%B5%D0%BD%D0%B8%D0%B5-%D1%81%D0%BE%D1%81%D1%82%D0%BE%D1%8F%D0%BD%D0%B8%D1%8F-%D0%B7%D0%B0%D0%BF%D0%B8%D1%81%D0%B8-%D1%80%D0%B5%D1%81%D1%83%D1%80%D1%81%D0%BE%D0%B2-%D1%81-%D0%BC%D0%B5%D1%82%D0%BA%D0%BE%D0%B9)Получение состояния записи ресурсов с меткой

Строка запроса **GET**: /api/v1/record/runing

##### [](#%D0%BF%D0%B0%D1%80%D0%B0%D0%BC%D0%B5%D1%82%D1%80%D1%8B-%D0%B7%D0%B0%D0%BF%D1%80%D0%BE%D1%81%D0%B0-10)Параметры запроса:

<table data-sourcepos="401:1-403:84" dir="auto" id="bkmrk-%D0%9F%D0%B0%D1%80%D0%B0%D0%BC%D0%B5%D1%82%D1%80-%D0%97%D0%BD%D0%B0%D1%87%D0%B5%D0%BD%D0%B8%D0%B5-%D0%9E%D0%BF-9"><thead><tr data-sourcepos="401:1-401:52"><th data-sourcepos="401:2-401:17">Параметр</th><th data-sourcepos="401:19-401:34">Значение</th><th data-sourcepos="401:36-401:51">Описание</th></tr></thead><tbody><tr data-sourcepos="403:1-403:84"><td data-sourcepos="403:2-403:9">tag\_name</td><td data-sourcepos="403:11-403:28">Текстовый</td><td data-sourcepos="403:30-403:83">Идентификатор метки ресурсов</td></tr></tbody></table>

##### [](#%D0%B2%D0%B0%D1%80%D0%B8%D0%B0%D0%BD%D1%82%D1%8B-%D0%BE%D1%82%D0%B2%D0%B5%D1%82%D0%B0-10)Варианты ответа:

**Ошибка 422**

```
{
  "detail": [
    {
      "loc": ["Положение ошибки"],
      "msg": "Сообщение ошибки",
      "type": "Тип ошибки"
    }
  ]
}
```

**Успешно** Значение *true* или *false*

#### [](#%D0%BF%D0%BE%D0%BB%D1%83%D1%87%D0%B5%D0%BD%D0%B8%D0%B5-%D0%B7%D0%B0%D0%BF%D0%B8%D1%81%D0%B8-%D1%80%D0%B5%D1%81%D1%83%D1%80%D1%81%D0%B0)Получение записи ресурса

Строка запроса **GET**: /api/v1/record/**{record\_id}**/

##### [](#%D0%BF%D0%B0%D1%80%D0%B0%D0%BC%D0%B5%D1%82%D1%80%D1%8B-%D0%B7%D0%B0%D0%BF%D1%80%D0%BE%D1%81%D0%B0-11)Параметры запроса:

<table data-sourcepos="429:1-431:115" dir="auto" id="bkmrk-%D0%9F%D0%B0%D1%80%D0%B0%D0%BC%D0%B5%D1%82%D1%80-%D0%97%D0%BD%D0%B0%D1%87%D0%B5%D0%BD%D0%B8%D0%B5-%D0%9E%D0%BF-10"><thead><tr data-sourcepos="429:1-429:52"><th data-sourcepos="429:2-429:17">Параметр</th><th data-sourcepos="429:19-429:34">Значение</th><th data-sourcepos="429:36-429:51">Описание</th></tr></thead><tbody><tr data-sourcepos="431:1-431:115"><td data-sourcepos="431:2-431:10">record\_id</td><td data-sourcepos="431:12-431:29">Текстовый</td><td data-sourcepos="431:31-431:114">Идентификатор записи ресурса *(часть запроса)*</td></tr></tbody></table>

##### [](#%D0%B2%D0%B0%D1%80%D0%B8%D0%B0%D0%BD%D1%82%D1%8B-%D0%BE%D1%82%D0%B2%D0%B5%D1%82%D0%B0-11)Варианты ответа:

**Ошибка 422**

```
{
  "detail": [
    {
      "loc": ["Положение ошибки"],
      "msg": "Сообщение ошибки",
      "type": "Тип ошибки"
    }
  ]
}
```

**Успешно**

```
{
  "id": "Идентификатор записи",
  "created_utc": "Дата-время создания записи",
  "status": "Состояние записи",
  "begin_utc": "Дата-время начала записи",
  "end_utc": "Дата-время окончания записи",
  "source": {
    "id": "Идентификатор ресурса",
    "created_utc": "Дата-время создания ресурса",
    "status": "Состояние доступности ресурса",
    "uri_rtsp": "Адрес RTSP потока",
    "uri_http_picture": {
      "uri": "Адрес получения изображения",
      "auth": "*basic* или *digest*",
      "user": "Пользователь",
      "password": "Пароль"
    },
    "description": "Описание ресурса",
    "ffmpeg_cmd": "Шаблон команды транскодирования потока"
  },
  "hash_md5": "Контрольная сумма записи MD5",
  "location": "Путь хранения записи",
  "sync_location": "Пусть для синхронизации видеозаписи с другим видеосервером"
}
```

#### [](#%D0%BF%D0%BE%D0%BB%D1%83%D1%87%D0%B5%D0%BD%D0%B8%D0%B5-%D1%87%D0%B0%D1%81%D1%82%D0%B8-%D1%84%D0%B0%D0%B9%D0%BB%D0%B0-%D0%B7%D0%B0%D0%BF%D0%B8%D1%81%D0%B8)Получение части файла записи

Строка запроса **GET**: /api/v1/record/**{record\_id}**/video/

##### [](#%D0%BF%D0%B0%D1%80%D0%B0%D0%BC%D0%B5%D1%82%D1%80%D1%8B-%D0%B7%D0%B0%D0%BF%D1%80%D0%BE%D1%81%D0%B0-12)Параметры запроса:

<table data-sourcepos="482:1-485:147" dir="auto" id="bkmrk-%D0%9F%D0%B0%D1%80%D0%B0%D0%BC%D0%B5%D1%82%D1%80-%D0%97%D0%BD%D0%B0%D1%87%D0%B5%D0%BD%D0%B8%D0%B5-%D0%9E%D0%BF-11"><thead><tr data-sourcepos="482:1-482:52"><th data-sourcepos="482:2-482:17">Параметр</th><th data-sourcepos="482:19-482:34">Значение</th><th data-sourcepos="482:36-482:51">Описание</th></tr></thead><tbody><tr data-sourcepos="484:1-484:115"><td data-sourcepos="484:2-484:10">record\_id</td><td data-sourcepos="484:12-484:29">Текстовый</td><td data-sourcepos="484:31-484:114">Идентификатор записи ресурса *(часть запроса)*</td></tr><tr data-sourcepos="485:1-485:147"><td data-sourcepos="485:2-485:6">range</td><td data-sourcepos="485:8-485:44">Численный-Численный</td><td data-sourcepos="485:46-485:146">Диапазон байт для загрузки, параметр заголовка запроса</td></tr></tbody></table>

##### [](#%D0%B2%D0%B0%D1%80%D0%B8%D0%B0%D0%BD%D1%82%D1%8B-%D0%BE%D1%82%D0%B2%D0%B5%D1%82%D0%B0-12)Варианты ответа:

**Ошибка 422**

```
{
  "detail": [
    {
      "loc": ["Положение ошибки"],
      "msg": "Сообщение ошибки",
      "type": "Тип ошибки"
    }
  ]
}
```

**Успешно** *Двоичные данные*

#### [](#%D1%83%D0%B4%D0%B0%D0%BB%D0%B5%D0%BD%D0%B8%D0%B5-%D1%84%D0%B0%D0%B9%D0%BB%D0%B0-%D0%B2%D0%B8%D0%B4%D0%B5%D0%BE%D0%B7%D0%B0%D0%BF%D0%B8%D1%81%D0%B8)Удаление файла видеозаписи

**DELETE**: /api/v1/record/**{record\_id}**/file/

##### [](#%D0%BF%D0%B0%D1%80%D0%B0%D0%BC%D0%B5%D1%82%D1%80%D1%8B-%D0%B7%D0%B0%D0%BF%D1%80%D0%BE%D1%81%D0%B0-13)Параметры запроса:

<table data-sourcepos="510:1-513:75" dir="auto" id="bkmrk-%D0%9F%D0%B0%D1%80%D0%B0%D0%BC%D0%B5%D1%82%D1%80-%D0%97%D0%BD%D0%B0%D1%87%D0%B5%D0%BD%D0%B8%D0%B5-%D0%9E%D0%BF-12"><thead><tr data-sourcepos="510:1-510:52"><th data-sourcepos="510:2-510:17">Параметр</th><th data-sourcepos="510:19-510:34">Значение</th><th data-sourcepos="510:36-510:51">Описание</th></tr></thead><tbody><tr data-sourcepos="512:1-512:115"><td data-sourcepos="512:2-512:10">record\_id</td><td data-sourcepos="512:12-512:29">Текстовый</td><td data-sourcepos="512:31-512:114">Идентификатор записи ресурса *(часть запроса)*</td></tr><tr data-sourcepos="513:1-513:75"><td data-sourcepos="513:2-513:9">location</td><td data-sourcepos="513:11-513:28">Текстовый</td><td data-sourcepos="513:30-513:74">Путь к файлу видеозаписи</td></tr></tbody></table>

##### [](#%D0%B2%D0%B0%D1%80%D0%B8%D0%B0%D0%BD%D1%82%D1%8B-%D0%BE%D1%82%D0%B2%D0%B5%D1%82%D0%B0-13)Варианты ответа:

**Ошибка 422**

```
{
  "detail": [
    {
      "loc": ["Положение ошибки"],
      "msg": "Сообщение ошибки",
      "type": "Тип ошибки"
    }
  ]
}
```

**Успешно**

```
{
  "id": "Идентификатор записи",
  "created_utc": "Дата-время создания записи",
  "status": "Состояние записи",
  "begin_utc": "Дата-время начала записи",
  "end_utc": "Дата-время окончания записи",
  "source": {
    "id": "Идентификатор ресурса",
    "created_utc": "Дата-время создания ресурса",
    "status": "Состояние доступности ресурса",
    "uri_rtsp": "Адрес RTSP потока",
    "uri_http_picture": {
      "uri": "Адрес получения изображения",
      "auth": "*basic* или *digest*",
      "user": "Пользователь",
      "password": "Пароль"
    },
    "description": "Описание ресурса",
    "ffmpeg_cmd": "Шаблон команды транскодирования потока"
  },
  "hash_md5": "Контрольная сумма записи MD5",
  "location": "Путь хранения записи",
  "sync_location": "Пусть для синхронизации видеозаписи с другим видеосервером"
}
```

### [](#%D1%83%D0%BF%D1%80%D0%B0%D0%B2%D0%BB%D0%B5%D0%BD%D0%B8%D0%B5-%D0%B3%D1%80%D1%83%D0%BF%D0%BF%D0%B0%D0%BC%D0%B8-%D0%BA%D0%B0%D0%BC%D0%B5%D1%80)Управление группами камер

#### [](#%D0%BF%D0%BE%D0%BB%D1%83%D1%87%D0%BD%D0%B8%D0%B5-%D1%81%D0%BF%D0%B8%D1%81%D0%BA%D0%B0-%D0%B3%D1%80%D1%83%D0%BF%D0%BF-%D0%BA%D0%B0%D0%BC%D0%B5%D1%80)Получние списка групп камер

Строка запроса **GET**: /api/v1/group

##### [](#%D0%BF%D0%B0%D1%80%D0%B0%D0%BC%D0%B5%D1%82%D1%80%D1%8B-%D0%B7%D0%B0%D0%BF%D1%80%D0%BE%D1%81%D0%B0-14)Параметры запроса:

*Параметры отсутствуют*

##### [](#%D0%B2%D0%B0%D1%80%D0%B8%D0%B0%D0%BD%D1%82%D1%8B-%D0%BE%D1%82%D0%B2%D0%B5%D1%82%D0%B0-14)Варианты ответа:

**Ошибка 422**

```
{
  "detail": [
    {
      "loc": ["Положение ошибки"],
      "msg": "Сообщение ошибки",
      "type": "Тип ошибки"
    }
  ]
}
```

**Успешно**

```
[
  {
    "id": "Идентификатор группы",
    "created_utc": "Дата-время создания группы",
    "name": "Имя группы"
  }
]
```

#### [](#%D1%81%D0%BE%D0%B7%D0%B4%D0%B0%D0%BD%D0%B8%D0%B5-%D0%B3%D1%80%D1%83%D0%BF%D0%BF%D1%8B-%D1%80%D0%B5%D1%81%D1%83%D1%80%D1%81%D0%BE%D0%B2)Создание группы ресурсов

**POST**: /api/v1/group

##### [](#%D0%BF%D0%B0%D1%80%D0%B0%D0%BC%D0%B5%D1%82%D1%80%D1%8B-%D0%B7%D0%B0%D0%BF%D1%80%D0%BE%D1%81%D0%B0-15)Параметры запроса:

<table data-sourcepos="599:1-602:63" dir="auto" id="bkmrk-%D0%9F%D0%B0%D1%80%D0%B0%D0%BC%D0%B5%D1%82%D1%80-%D0%97%D0%BD%D0%B0%D1%87%D0%B5%D0%BD%D0%B8%D0%B5-%D0%9E%D0%BF-13"><thead><tr data-sourcepos="599:1-599:52"><th data-sourcepos="599:2-599:17">Параметр</th><th data-sourcepos="599:19-599:34">Значение</th><th data-sourcepos="599:36-599:51">Описание</th></tr></thead><tbody><tr data-sourcepos="601:1-601:136"><td data-sourcepos="601:2-601:6">model</td><td data-sourcepos="601:8-601:25">Текстовый</td><td data-sourcepos="601:27-601:135">Модель метки записи ресурса для изменений *Source* или *PictureSource*</td></tr><tr data-sourcepos="602:1-602:63"><td data-sourcepos="602:2-602:5">name</td><td data-sourcepos="602:7-602:24">Текстовый</td><td data-sourcepos="602:26-602:62">Наименование группы</td></tr></tbody></table>

##### [](#%D0%B2%D0%B0%D1%80%D0%B8%D0%B0%D0%BD%D1%82%D1%8B-%D0%BE%D1%82%D0%B2%D0%B5%D1%82%D0%B0-15)Варианты ответа:

**Ошибка 422**

```
{
  "detail": [
    {
      "loc": ["Положение ошибки"],
      "msg": "Сообщение ошибки",
      "type": "Тип ошибки"
    }
  ]
}
```

**Успешно**

```
[
  {
    "id": "Идентификатор группы",
    "created_utc": "Дата-время создания группы",
    "name": "Имя группы"
  }
]
```

#### [](#%D0%BF%D0%BE%D0%BB%D1%83%D1%87%D0%B5%D0%BD%D0%B8%D0%B5-%D1%81%D0%B2%D0%B5%D0%B4%D0%B5%D0%BD%D0%B8%D0%B9-%D0%BE-%D0%B3%D1%80%D1%83%D0%BF%D0%BF%D0%B5-%D1%80%D0%B5%D1%81%D1%83%D1%80%D1%81%D0%BE%D0%B2)Получение сведений о группе ресурсов

Строка запроса **GET**: /api/v1/group/**{group\_id}**/

##### [](#%D0%BF%D0%B0%D1%80%D0%B0%D0%BC%D0%B5%D1%82%D1%80%D1%8B-%D0%B7%D0%B0%D0%BF%D1%80%D0%BE%D1%81%D0%B0-16)Параметры запроса:

<table data-sourcepos="636:1-638:116" dir="auto" id="bkmrk-%D0%9F%D0%B0%D1%80%D0%B0%D0%BC%D0%B5%D1%82%D1%80-%D0%97%D0%BD%D0%B0%D1%87%D0%B5%D0%BD%D0%B8%D0%B5-%D0%9E%D0%BF-14"><thead><tr data-sourcepos="636:1-636:52"><th data-sourcepos="636:2-636:17">Параметр</th><th data-sourcepos="636:19-636:34">Значение</th><th data-sourcepos="636:36-636:51">Описание</th></tr></thead><tbody><tr data-sourcepos="638:1-638:116"><td data-sourcepos="638:2-638:9">group\_id</td><td data-sourcepos="638:11-638:28">Текстовый</td><td data-sourcepos="638:30-638:115">Идентификатор группы ресурсов *(часть запроса)*</td></tr></tbody></table>

##### [](#%D0%B2%D0%B0%D1%80%D0%B8%D0%B0%D0%BD%D1%82%D1%8B-%D0%BE%D1%82%D0%B2%D0%B5%D1%82%D0%B0-16)Варианты ответа:

**Ошибка 422**

```
{
  "detail": [
    {
      "loc": ["Положение ошибки"],
      "msg": "Сообщение ошибки",
      "type": "Тип ошибки"
    }
  ]
}
```

**Успешно**

```
{
  "id": "Идентификатор группы ресурсов",
  "сreated_utc": "Дата-время создания группы",
  "name": "Наименование группы",
  "sources": [
    {
      "id": "Идентификатор ресурса",
      "created_utc": "Дата-время создания ресурса",
      "uri_rtsp": "Адрес RTSP потока",
      "uri_http_picture": {
        "uri": "Адрес получения изображения",
        "auth": "*basic* или *digest*",
        "user": "Пользователь",
        "password": "Пароль"
      },
      "description": "Описание ресурса",
      "ffmpeg_cmd": "Шаблон команды транскодирования потока"
    }
  ]
}
```

#### [](#%D1%83%D0%B4%D0%B0%D0%BB%D0%B5%D0%BD%D0%B8%D0%B5-%D0%B3%D1%80%D1%83%D0%BF%D0%BF%D1%8B-%D1%80%D0%B5%D1%81%D1%83%D1%80%D1%81%D0%BE%D0%B2)Удаление группы ресурсов

**DELETE**: /api/v1/group/**{group\_id}**/

##### [](#%D0%BF%D0%B0%D1%80%D0%B0%D0%BC%D0%B5%D1%82%D1%80%D1%8B-%D0%B7%D0%B0%D0%BF%D1%80%D0%BE%D1%81%D0%B0-17)Параметры запроса:

<table data-sourcepos="684:1-686:116" dir="auto" id="bkmrk-%D0%9F%D0%B0%D1%80%D0%B0%D0%BC%D0%B5%D1%82%D1%80-%D0%97%D0%BD%D0%B0%D1%87%D0%B5%D0%BD%D0%B8%D0%B5-%D0%9E%D0%BF-15"><thead><tr data-sourcepos="684:1-684:52"><th data-sourcepos="684:2-684:17">Параметр</th><th data-sourcepos="684:19-684:34">Значение</th><th data-sourcepos="684:36-684:51">Описание</th></tr></thead><tbody><tr data-sourcepos="686:1-686:116"><td data-sourcepos="686:2-686:9">group\_id</td><td data-sourcepos="686:11-686:28">Текстовый</td><td data-sourcepos="686:30-686:115">Идентификатор группы ресурсов *(часть запроса)*</td></tr></tbody></table>

##### [](#%D0%B2%D0%B0%D1%80%D0%B8%D0%B0%D0%BD%D1%82%D1%8B-%D0%BE%D1%82%D0%B2%D0%B5%D1%82%D0%B0-17)Варианты ответа:

**Ошибка 422**

```
{
  "detail": [
    {
      "loc": ["Положение ошибки"],
      "msg": "Сообщение ошибки",
      "type": "Тип ошибки"
    }
  ]
}
```

**Успешно**

```
{
  "id": "Идентификатор группы ресурсов",
  "сreated_utc": "Дата-время создания группы",
  "name": "Наименование группы"
}
```

#### [](#%D0%B4%D0%BE%D0%B1%D0%B0%D0%B2%D0%BB%D0%B5%D0%BD%D0%B8%D0%B5-%D1%80%D0%B5%D1%81%D1%83%D1%80%D1%81%D0%B0-%D0%B2-%D0%B3%D1%80%D1%83%D0%BF%D0%BF%D1%83-%D1%80%D0%B5%D1%81%D1%83%D1%80%D1%81%D0%BE%D0%B2)Добавление ресурса в группу ресурсов

**POST**: /api/v1/group/**{group\_id}**/source/**{source\_id}**/

##### [](#%D0%BF%D0%B0%D1%80%D0%B0%D0%BC%D0%B5%D1%82%D1%80%D1%8B-%D0%B7%D0%B0%D0%BF%D1%80%D0%BE%D1%81%D0%B0-18)Параметры запроса:

<table data-sourcepos="717:1-720:102" dir="auto" id="bkmrk-%D0%9F%D0%B0%D1%80%D0%B0%D0%BC%D0%B5%D1%82%D1%80-%D0%97%D0%BD%D0%B0%D1%87%D0%B5%D0%BD%D0%B8%D0%B5-%D0%9E%D0%BF-16"><thead><tr data-sourcepos="717:1-717:52"><th data-sourcepos="717:2-717:17">Параметр</th><th data-sourcepos="717:19-717:34">Значение</th><th data-sourcepos="717:36-717:51">Описание</th></tr></thead><tbody><tr data-sourcepos="719:1-719:116"><td data-sourcepos="719:2-719:9">group\_id</td><td data-sourcepos="719:11-719:28">Текстовый</td><td data-sourcepos="719:30-719:115">Идентификатор группы ресурсов *(часть запроса)*</td></tr><tr data-sourcepos="720:1-720:102"><td data-sourcepos="720:2-720:10">source\_id</td><td data-sourcepos="720:12-720:29">Текстовый</td><td data-sourcepos="720:31-720:101">Идентификатор ресурса *(часть запроса)*</td></tr></tbody></table>

##### [](#%D0%B2%D0%B0%D1%80%D0%B8%D0%B0%D0%BD%D1%82%D1%8B-%D0%BE%D1%82%D0%B2%D0%B5%D1%82%D0%B0-18)Варианты ответа:

**Ошибка 422**

```
{
  "detail": [
    {
      "loc": ["Положение ошибки"],
      "msg": "Сообщение ошибки",
      "type": "Тип ошибки"
    }
  ]
}
```

**Успешно** Значение *true* или *false*

#### [](#%D1%83%D0%B4%D0%B0%D0%BB%D0%B5%D0%BD%D0%B8%D0%B5-%D1%80%D0%B5%D1%81%D1%83%D1%80%D1%81%D0%B0-%D0%B8%D0%B7-%D0%B3%D1%80%D1%83%D0%BF%D0%BF%D1%8B-%D1%80%D0%B5%D1%81%D1%83%D1%80%D1%81%D0%BE%D0%B2)Удаление ресурса из группы ресурсов

**DELETE**: /api/v1/group/**{group\_id}**/source/**{source\_id}**/

##### [](#%D0%BF%D0%B0%D1%80%D0%B0%D0%BC%D0%B5%D1%82%D1%80%D1%8B-%D0%B7%D0%B0%D0%BF%D1%80%D0%BE%D1%81%D0%B0-19)Параметры запроса:

<table data-sourcepos="745:1-748:102" dir="auto" id="bkmrk-%D0%9F%D0%B0%D1%80%D0%B0%D0%BC%D0%B5%D1%82%D1%80-%D0%97%D0%BD%D0%B0%D1%87%D0%B5%D0%BD%D0%B8%D0%B5-%D0%9E%D0%BF-17"><thead><tr data-sourcepos="745:1-745:52"><th data-sourcepos="745:2-745:17">Параметр</th><th data-sourcepos="745:19-745:34">Значение</th><th data-sourcepos="745:36-745:51">Описание</th></tr></thead><tbody><tr data-sourcepos="747:1-747:116"><td data-sourcepos="747:2-747:9">group\_id</td><td data-sourcepos="747:11-747:28">Текстовый</td><td data-sourcepos="747:30-747:115">Идентификатор группы ресурсов *(часть запроса)*</td></tr><tr data-sourcepos="748:1-748:102"><td data-sourcepos="748:2-748:10">source\_id</td><td data-sourcepos="748:12-748:29">Текстовый</td><td data-sourcepos="748:31-748:101">Идентификатор ресурса *(часть запроса)*</td></tr></tbody></table>

##### [](#%D0%B2%D0%B0%D1%80%D0%B8%D0%B0%D0%BD%D1%82%D1%8B-%D0%BE%D1%82%D0%B2%D0%B5%D1%82%D0%B0-19)Варианты ответа:

**Ошибка 422**

```
{
  "detail": [
    {
      "loc": ["Положение ошибки"],
      "msg": "Сообщение ошибки",
      "type": "Тип ошибки"
    }
  ]
}
```

**Успешно** Значение *true* или *false*//\*

### [](#%D1%83%D0%BF%D1%80%D0%B0%D0%B2%D0%BB%D0%B5%D0%BD%D0%B8%D0%B5-%D0%BC%D0%B5%D1%82%D0%BA%D0%B0%D0%BC%D0%B8-%D0%B7%D0%B0%D0%BF%D0%B8%D1%81%D0%B5%D0%B9)Управление метками записей

#### [](#%D0%BF%D0%BE%D0%BB%D1%83%D1%87%D0%B5%D0%BD%D0%B8%D0%B5-%D0%BC%D0%B5%D1%82%D0%BA%D0%B8-%D0%B7%D0%B0%D0%BF%D0%B8%D1%81%D0%B8-%D1%80%D0%B5%D1%81%D1%83%D1%80%D1%81%D0%BE%D0%B2)Получение метки записи ресурсов

Строка запроса **GET**: /api/v1/tag

##### [](#%D0%BF%D0%B0%D1%80%D0%B0%D0%BC%D0%B5%D1%82%D1%80%D1%8B-%D0%B7%D0%B0%D0%BF%D1%80%D0%BE%D1%81%D0%B0-20)Параметры запроса:

<table data-sourcepos="776:1-778:61" dir="auto" id="bkmrk-%D0%9F%D0%B0%D1%80%D0%B0%D0%BC%D0%B5%D1%82%D1%80-%D0%97%D0%BD%D0%B0%D1%87%D0%B5%D0%BD%D0%B8%D0%B5-%D0%9E%D0%BF-18"><thead><tr data-sourcepos="776:1-776:52"><th data-sourcepos="776:2-776:17">Параметр</th><th data-sourcepos="776:19-776:34">Значение</th><th data-sourcepos="776:36-776:51">Описание</th></tr></thead><tbody><tr data-sourcepos="778:1-778:61"><td data-sourcepos="778:2-778:5">name</td><td data-sourcepos="778:7-778:24">Текстовый</td><td data-sourcepos="778:26-778:60">Наименование метки</td></tr></tbody></table>

##### [](#%D0%B2%D0%B0%D1%80%D0%B8%D0%B0%D0%BD%D1%82%D1%8B-%D0%BE%D1%82%D0%B2%D0%B5%D1%82%D0%B0-20)Варианты ответа:

**Ошибка 422**

```
{
  "detail": [
    {
      "loc": ["Положение ошибки"],
      "msg": "Сообщение ошибки",
      "type": "Тип ошибки"
    }
  ]
}
```

**Успешно**

```
{
  "id": "Идентификатор тега",
  "created_utc": "Дата-время создания тега",
  "name": "Имя тега",
  "records": [
    {
      "id": "Идентификатор записи",
      "created_utc": "Дата-время создания записи",
      "status": "Состояние записи",
      "begin_utc": "Дата-время начала записи",
      "end_utc": "Дата-время окончания записи",
      "source": {
        "id": "Идентификатор ресурса",
        "created_utc": "Дата-время создания ресурса",
        "uri_rtsp": "Адрес RTSP потока",
        "uri_http_picture": {
          "uri": "Адрес получения изображения",
          "auth": "*basic* или *digest*",
          "user": "Пользователь",
          "password": "Пароль"
        },
        "description": "Описание ресурса",
        "ffmpeg_cmd": "Шаблон команды транскодирования потока"
      },
      "hash_md5": "Контрольная сумма записи MD5",
      "location": "Путь хранения записи",
      "sync_location": "Пусть для синхронизации видеозаписи с другим видеосервером"
    }
  ]
}
```

#### [](#%D0%BF%D0%BE%D0%BB%D1%83%D1%87%D0%B8%D1%82%D1%8C-%D0%BD%D0%B0%D1%87%D0%B0%D1%82%D1%8B%D0%B5-%D0%BC%D0%B5%D1%82%D0%BA%D0%B8)Получить начатые метки

Строка запроса **GET**: /api/v1/tag/begin

##### [](#%D0%BF%D0%B0%D1%80%D0%B0%D0%BC%D0%B5%D1%82%D1%80%D1%8B-%D0%B7%D0%B0%D0%BF%D1%80%D0%BE%D1%81%D0%B0-21)Параметры запроса:

*Параметры отсутствуют*

##### [](#%D0%B2%D0%B0%D1%80%D0%B8%D0%B0%D0%BD%D1%82%D1%8B-%D0%BE%D1%82%D0%B2%D0%B5%D1%82%D0%B0-21)Варианты ответа:

**Успешно**

```
["Наименование метки"]
```

### [](#%D1%81%D0%B8%D0%BD%D1%85%D1%80%D0%BE%D0%BD%D0%B8%D0%B7%D0%B0%D1%86%D0%B8%D1%8F-%D0%B4%D0%B0%D0%BD%D0%BD%D1%8B%D1%85)Синхронизация данных

#### [](#%D0%BD%D0%B0%D1%87%D0%B0%D1%82%D1%8C-%D1%81%D0%B8%D0%BD%D1%85%D1%80%D0%BE%D0%BD%D0%B8%D0%B7%D0%B0%D1%86%D0%B8%D1%8E-%D0%B2%D0%B8%D0%B4%D0%B5%D0%BE)Начать синхронизацию видео

**POST**: /api/v1/sync

##### [](#%D0%BF%D0%B0%D1%80%D0%B0%D0%BC%D0%B5%D1%82%D1%80%D1%8B-%D0%B7%D0%B0%D0%BF%D1%80%D0%BE%D1%81%D0%B0-22)Параметры запроса:

<table data-sourcepos="851:1-854:65" dir="auto" id="bkmrk-%D0%9F%D0%B0%D1%80%D0%B0%D0%BC%D0%B5%D1%82%D1%80-%D0%97%D0%BD%D0%B0%D1%87%D0%B5%D0%BD%D0%B8%D0%B5-%D0%9E%D0%BF-19"><thead><tr data-sourcepos="851:1-851:52"><th data-sourcepos="851:2-851:17">Параметр</th><th data-sourcepos="851:19-851:34">Значение</th><th data-sourcepos="851:36-851:51">Описание</th></tr></thead><tbody><tr data-sourcepos="853:1-853:65"><td data-sourcepos="853:2-853:9">tag\_name</td><td data-sourcepos="853:11-853:28">Текстовый</td><td data-sourcepos="853:30-853:64">Наименование метки</td></tr><tr data-sourcepos="854:1-854:65"><td data-sourcepos="854:2-854:9">location</td><td data-sourcepos="854:11-854:28">Текстовый</td><td data-sourcepos="854:30-854:64">Расположение файла</td></tr></tbody></table>

##### [](#%D0%B2%D0%B0%D1%80%D0%B8%D0%B0%D0%BD%D1%82%D1%8B-%D0%BE%D1%82%D0%B2%D0%B5%D1%82%D0%B0-22)Варианты ответа:

**Ошибка 422**

```
{
  "detail": [
    {
      "loc": ["Положение ошибки"],
      "msg": "Сообщение ошибки",
      "type": "Тип ошибки"
    }
  ]
}
```

**Успешно** *Строковые данные*

### [](#%D1%80%D0%B0%D0%B7%D0%BB%D0%B8%D1%87%D0%BD%D1%8B%D0%B5-%D0%BF%D1%80%D0%BE%D0%B2%D0%B5%D1%80%D0%BA%D0%B8)Различные проверки

#### [](#%D0%BF%D1%80%D0%BE%D0%B2%D0%B5%D1%80%D0%BA%D0%B0-%D0%B8%D0%B7%D0%BE%D0%B1%D1%80%D0%B0%D0%B6%D0%B5%D0%BD%D0%B8%D1%8F)Проверка изображения

Строка запроса **GET**: /test/img

##### [](#%D0%BF%D0%B0%D1%80%D0%B0%D0%BC%D0%B5%D1%82%D1%80%D1%8B-%D0%B7%D0%B0%D0%BF%D1%80%D0%BE%D1%81%D0%B0-23)Параметры запроса:

*Не имеет параметров*

##### [](#%D0%B2%D0%B0%D1%80%D0%B8%D0%B0%D0%BD%D1%82%D1%8B-%D0%BE%D1%82%D0%B2%D0%B5%D1%82%D0%B0-23)Варианты ответа:

**Успешно** *Не имеет ответа*

#### [](#%D0%BF%D1%80%D0%BE%D0%B2%D0%B5%D1%80%D0%BA%D0%B0-%D0%B2%D0%B8%D0%B4%D0%B5%D0%BE)Проверка видео

Строка запроса **GET**: /test/video

##### [](#%D0%BF%D0%B0%D1%80%D0%B0%D0%BC%D0%B5%D1%82%D1%80%D1%8B-%D0%B7%D0%B0%D0%BF%D1%80%D0%BE%D1%81%D0%B0-24)Параметры запроса:

*Не имеет параметров*

##### [](#%D0%B2%D0%B0%D1%80%D0%B8%D0%B0%D0%BD%D1%82%D1%8B-%D0%BE%D1%82%D0%B2%D0%B5%D1%82%D0%B0-24)Варианты ответа:

**Успешно** *Не имеет ответа*