Связь R3 API 1.7.0
Методы API для работы с разделом «Связь R3».
Базовый путь: https://{IP_контроллера}/api/v1.
Версия описания API: 1.7.0.
Примеры используют placeholder-значения для паролей, token, UUID, адресов и секретов. Перед выполнением запроса замените их на значения вашего контроллера.
Методы раздела
| Метод | Путь |
|---|---|
GET | /security_integration/r3_link |
POST | /security_integration/r3_link |
PUT | /security_integration/r3_link/{id} |
PATCH | /security_integration/r3_link/{id} |
DELETE | /security_integration/r3_link/{id} |
GET /security_integration/r3_link
Раздел: Связь R3.
Возвращает конфигурацию интеграции R3 Link.
Параметры и ответы по OpenAPI
{
"description": "Get R3 link integration configuration",
"responses": {
"200": {
"description": "Successfully received R3 link integration configuration",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "object",
"required": [
"uuid",
"controller",
"status",
"state",
"ip_adr_r3mc",
"udp_port",
"mask"
],
"properties": {
"uuid": {
"type": "string",
"pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$"
},
"controller": {
"type": "string",
"description": "Серийник контроллера, к которому подключен R3MC"
},
"status": {
"type": "string",
"enum": [
"ACTIVE",
"INACTIVE"
]
},
"state": {
"type": "string",
"enum": [
"ONLINE",
"OFFLINE",
"UNKNOWN"
]
},
"ip_adr_r3mc": {
"type": "string",
"pattern": "^(25[0-5]|2[0-4][0-9]|1[0-9]{2}|[1-9]?[0-9])\\.(25[0-5]|2[0-4][0-9]|1[0-9]{2}|[1-9]?[0-9])\\.(25[0-5]|2[0-4][0-9]|1[0-9]{2}|[1-9]?[0-9])\\.(25[0-5]|2[0-4][0-9]|1[0-9]{2}|[1-9]?[0-9])$",
"description": "IP Адрес R3MC"
},
"udp_port": {
"type": "integer",
"description": "Порт"
},
"mask": {
"type": "string",
"pattern": "^(25[0-5]|2[0-4][0-9]|1[0-9]{2}|[1-9]?[0-9])\\.(25[0-5]|2[0-4][0-9]|1[0-9]{2}|[1-9]?[0-9])\\.(25[0-5]|2[0-4][0-9]|1[0-9]{2}|[1-9]?[0-9])\\.(25[0-5]|2[0-4][0-9]|1[0-9]{2}|[1-9]?[0-9])$",
"description": "Маска подсети"
},
"ip_adr_strazh": {
"type": "string",
"pattern": "^(25[0-5]|2[0-4][0-9]|1[0-9]{2}|[1-9]?[0-9])\\.(25[0-5]|2[0-4][0-9]|1[0-9]{2}|[1-9]?[0-9])\\.(25[0-5]|2[0-4][0-9]|1[0-9]{2}|[1-9]?[0-9])\\.(25[0-5]|2[0-4][0-9]|1[0-9]{2}|[1-9]?[0-9])$",
"description": "IP Адрес от R3MC"
},
"config": {
"type": "object",
"required": [
"devices",
"sec_zones"
],
"properties": {
"devices": {
"type": "array",
"items": {
"type": "object",
"required": [
"address",
"deviceType"
],
"properties": {
"address": {
"type": "integer",
"minimum": 0
},
"deviceType": {
"type": "integer"
},
"description": {
"type": "string"
}
}
}
},
"sec_zones": {
"type": "array",
"items": {
"type": "object",
"required": [
"devices",
"address"
],
"properties": {
"devices": {
"type": "array",
"items": {
"type": "object",
"required": [
"address",
"zone"
],
"properties": {
"address": {
"type": "integer",
"minimum": 0
},
"zone": {
"type": "integer"
}
}
}
},
"address": {
"type": "integer",
"minimum": 0
},
"description": {
"type": "string"
}
}
}
}
}
},
"zones": {
"type": "array",
"items": {
"type": "object",
"required": [
"id",
"access_points"
],
"properties": {
"id": {
"type": "integer",
"minimum": 1,
"description": "Security zone in R3 link"
},
"access_points": {
"type": "array",
"items": {
"type": "string",
"description": "Access points in security zone",
"pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$"
}
},
"status": {
"type": "string",
"description": "zone status from integration"
}
}
}
},
"statistic": {
"type": "array",
"items": {
"type": "object",
"properties": {
"rx": {
"type": "integer",
"description": "receive packages"
},
"tx": {
"type": "integer",
"description": "outgoing packages"
},
"link": {
"type": "string",
"description": "is device online"
}
}
}
}
}
}
}
}
}
},
"500": {
"description": "Server error",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"success"
],
"properties": {
"success": {
"type": "boolean",
"example": false
},
"message": {
"type": "string"
},
"data": {
"type": "object"
}
}
}
}
}
}
}
}
Примеры по OpenAPI
Сформированы по схеме контроллера; значения полей необходимо заменить.
Пример запроса
curl -k -X GET "https://{IP_контроллера}/api/v1/security_integration/r3_link" \
-H "Authorization: Bearer <token>"
Пример ответа
[
{
"uuid": "string",
"controller": "string",
"status": "ACTIVE",
"state": "ONLINE",
"ip_adr_r3mc": "string",
"udp_port": 1,
"mask": "string",
"ip_adr_strazh": "string",
"config": {
"devices": [
{
"address": 1,
"deviceType": 1,
"description": "string"
}
],
"sec_zones": [
{
"devices": [
{
"address": 1,
"zone": 1
}
],
"address": 1,
"description": "string"
}
]
},
"zones": [
{
"id": 1,
"access_points": [
"string"
],
"status": "string"
}
],
"statistic": [
{
"rx": 1,
"tx": 1,
"link": "string"
}
]
}
]
POST /security_integration/r3_link
Раздел: Связь R3.
Устанавливает конфигурацию интеграции R3 Link.
Параметры и ответы по OpenAPI
{
"description": "Set R3 link integration configuration",
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"uuid",
"controller",
"status",
"state",
"ip_adr_r3mc",
"udp_port",
"mask"
],
"properties": {
"uuid": {
"type": "string",
"pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$"
},
"controller": {
"type": "string",
"description": "Серийник контроллера, к которому подключен R3MC"
},
"status": {
"type": "string",
"enum": [
"ACTIVE",
"INACTIVE"
]
},
"state": {
"type": "string",
"enum": [
"ONLINE",
"OFFLINE",
"UNKNOWN"
]
},
"ip_adr_r3mc": {
"type": "string",
"pattern": "^(25[0-5]|2[0-4][0-9]|1[0-9]{2}|[1-9]?[0-9])\\.(25[0-5]|2[0-4][0-9]|1[0-9]{2}|[1-9]?[0-9])\\.(25[0-5]|2[0-4][0-9]|1[0-9]{2}|[1-9]?[0-9])\\.(25[0-5]|2[0-4][0-9]|1[0-9]{2}|[1-9]?[0-9])$",
"description": "IP Адрес R3MC"
},
"udp_port": {
"type": "integer",
"description": "Порт"
},
"mask": {
"type": "string",
"pattern": "^(25[0-5]|2[0-4][0-9]|1[0-9]{2}|[1-9]?[0-9])\\.(25[0-5]|2[0-4][0-9]|1[0-9]{2}|[1-9]?[0-9])\\.(25[0-5]|2[0-4][0-9]|1[0-9]{2}|[1-9]?[0-9])\\.(25[0-5]|2[0-4][0-9]|1[0-9]{2}|[1-9]?[0-9])$",
"description": "Маска подсети"
},
"ip_adr_strazh": {
"type": "string",
"pattern": "^(25[0-5]|2[0-4][0-9]|1[0-9]{2}|[1-9]?[0-9])\\.(25[0-5]|2[0-4][0-9]|1[0-9]{2}|[1-9]?[0-9])\\.(25[0-5]|2[0-4][0-9]|1[0-9]{2}|[1-9]?[0-9])\\.(25[0-5]|2[0-4][0-9]|1[0-9]{2}|[1-9]?[0-9])$",
"description": "IP Адрес от R3MC"
},
"config": {
"type": "object",
"required": [
"devices",
"sec_zones"
],
"properties": {
"devices": {
"type": "array",
"items": {
"type": "object",
"required": [
"address",
"deviceType"
],
"properties": {
"address": {
"type": "integer",
"minimum": 0
},
"deviceType": {
"type": "integer"
},
"description": {
"type": "string"
}
}
}
},
"sec_zones": {
"type": "array",
"items": {
"type": "object",
"required": [
"devices",
"address"
],
"properties": {
"devices": {
"type": "array",
"items": {
"type": "object",
"required": [
"address",
"zone"
],
"properties": {
"address": {
"type": "integer",
"minimum": 0
},
"zone": {
"type": "integer"
}
}
}
},
"address": {
"type": "integer",
"minimum": 0
},
"description": {
"type": "string"
}
}
}
}
}
},
"zones": {
"type": "array",
"items": {
"type": "object",
"required": [
"id",
"access_points"
],
"properties": {
"id": {
"type": "integer",
"minimum": 1,
"description": "Security zone in R3 link"
},
"access_points": {
"type": "array",
"items": {
"type": "string",
"description": "Access points in security zone",
"pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$"
}
},
"status": {
"type": "string",
"description": "zone status from integration"
}
}
}
},
"statistic": {
"type": "array",
"items": {
"type": "object",
"properties": {
"rx": {
"type": "integer",
"description": "receive packages"
},
"tx": {
"type": "integer",
"description": "outgoing packages"
},
"link": {
"type": "string",
"description": "is device online"
}
}
}
}
}
}
}
}
},
"responses": {
"200": {
"description": "Successfully set new R3 link configuration",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"success"
],
"properties": {
"success": {
"type": "boolean",
"example": false
},
"message": {
"type": "string"
},
"data": {
"type": "object"
}
}
}
}
}
},
"400": {
"description": "Bad request parameters",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"success"
],
"properties": {
"success": {
"type": "boolean",
"example": false
},
"message": {
"type": "string"
},
"data": {
"type": "object"
}
}
}
}
}
},
"500": {
"description": "Server error",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"success"
],
"properties": {
"success": {
"type": "boolean",
"example": false
},
"message": {
"type": "string"
},
"data": {
"type": "object"
}
}
}
}
}
}
}
}
Примеры по OpenAPI
Сформированы по схеме контроллера; значения полей необходимо заменить.
Пример запроса
curl -k -X POST "https://{IP_контроллера}/api/v1/security_integration/r3_link" \
-H "Authorization: Bearer <token>" \
-H "Content-Type: application/json" \
--data-raw '{
"uuid": "string",
"controller": "string",
"status": "ACTIVE",
"state": "ONLINE",
"ip_adr_r3mc": "string",
"udp_port": 1,
"mask": "string",
"ip_adr_strazh": "string",
"config": {
"devices": [
{
"address": 1,
"deviceType": 1,
"description": "string"
}
],
"sec_zones": [
{
"devices": [
{
"address": 1,
"zone": 1
}
],
"address": 1,
"description": "string"
}
]
},
"zones": [
{
"id": 1,
"access_points": [
"string"
],
"status": "string"
}
],
"statistic": [
{
"rx": 1,
"tx": 1,
"link": "string"
}
]
}'
Пример тела запроса
{
"uuid": "string",
"controller": "string",
"status": "ACTIVE",
"state": "ONLINE",
"ip_adr_r3mc": "string",
"udp_port": 1,
"mask": "string",
"ip_adr_strazh": "string",
"config": {
"devices": [
{
"address": 1,
"deviceType": 1,
"description": "string"
}
],
"sec_zones": [
{
"devices": [
{
"address": 1,
"zone": 1
}
],
"address": 1,
"description": "string"
}
]
},
"zones": [
{
"id": 1,
"access_points": [
"string"
],
"status": "string"
}
],
"statistic": [
{
"rx": 1,
"tx": 1,
"link": "string"
}
]
}
Пример ответа
{
"success": false,
"message": "string",
"data": {}
}
PUT /security_integration/r3_link/{id}
Раздел: Связь R3.
Устанавливает конфигурацию интеграции R3 Link.
Параметры и ответы по OpenAPI
{
"description": "Set R3 link integration configuration",
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"uuid",
"controller",
"status",
"state",
"ip_adr_r3mc",
"udp_port",
"mask"
],
"properties": {
"uuid": {
"type": "string",
"pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$"
},
"controller": {
"type": "string",
"description": "Серийник контроллера, к которому подключен R3MC"
},
"status": {
"type": "string",
"enum": [
"ACTIVE",
"INACTIVE"
]
},
"state": {
"type": "string",
"enum": [
"ONLINE",
"OFFLINE",
"UNKNOWN"
]
},
"ip_adr_r3mc": {
"type": "string",
"pattern": "^(25[0-5]|2[0-4][0-9]|1[0-9]{2}|[1-9]?[0-9])\\.(25[0-5]|2[0-4][0-9]|1[0-9]{2}|[1-9]?[0-9])\\.(25[0-5]|2[0-4][0-9]|1[0-9]{2}|[1-9]?[0-9])\\.(25[0-5]|2[0-4][0-9]|1[0-9]{2}|[1-9]?[0-9])$",
"description": "IP Адрес R3MC"
},
"udp_port": {
"type": "integer",
"description": "Порт"
},
"mask": {
"type": "string",
"pattern": "^(25[0-5]|2[0-4][0-9]|1[0-9]{2}|[1-9]?[0-9])\\.(25[0-5]|2[0-4][0-9]|1[0-9]{2}|[1-9]?[0-9])\\.(25[0-5]|2[0-4][0-9]|1[0-9]{2}|[1-9]?[0-9])\\.(25[0-5]|2[0-4][0-9]|1[0-9]{2}|[1-9]?[0-9])$",
"description": "Маска подсети"
},
"ip_adr_strazh": {
"type": "string",
"pattern": "^(25[0-5]|2[0-4][0-9]|1[0-9]{2}|[1-9]?[0-9])\\.(25[0-5]|2[0-4][0-9]|1[0-9]{2}|[1-9]?[0-9])\\.(25[0-5]|2[0-4][0-9]|1[0-9]{2}|[1-9]?[0-9])\\.(25[0-5]|2[0-4][0-9]|1[0-9]{2}|[1-9]?[0-9])$",
"description": "IP Адрес от R3MC"
},
"config": {
"type": "object",
"required": [
"devices",
"sec_zones"
],
"properties": {
"devices": {
"type": "array",
"items": {
"type": "object",
"required": [
"address",
"deviceType"
],
"properties": {
"address": {
"type": "integer",
"minimum": 0
},
"deviceType": {
"type": "integer"
},
"description": {
"type": "string"
}
}
}
},
"sec_zones": {
"type": "array",
"items": {
"type": "object",
"required": [
"devices",
"address"
],
"properties": {
"devices": {
"type": "array",
"items": {
"type": "object",
"required": [
"address",
"zone"
],
"properties": {
"address": {
"type": "integer",
"minimum": 0
},
"zone": {
"type": "integer"
}
}
}
},
"address": {
"type": "integer",
"minimum": 0
},
"description": {
"type": "string"
}
}
}
}
}
},
"zones": {
"type": "array",
"items": {
"type": "object",
"required": [
"id",
"access_points"
],
"properties": {
"id": {
"type": "integer",
"minimum": 1,
"description": "Security zone in R3 link"
},
"access_points": {
"type": "array",
"items": {
"type": "string",
"description": "Access points in security zone",
"pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$"
}
},
"status": {
"type": "string",
"description": "zone status from integration"
}
}
}
},
"statistic": {
"type": "array",
"items": {
"type": "object",
"properties": {
"rx": {
"type": "integer",
"description": "receive packages"
},
"tx": {
"type": "integer",
"description": "outgoing packages"
},
"link": {
"type": "string",
"description": "is device online"
}
}
}
}
}
}
}
}
},
"responses": {
"200": {
"description": "Successfully put new R3 link configuration",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"success"
],
"properties": {
"success": {
"type": "boolean",
"example": false
},
"message": {
"type": "string"
},
"data": {
"type": "object"
}
}
}
}
}
},
"400": {
"description": "Bad request parameters",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"success"
],
"properties": {
"success": {
"type": "boolean",
"example": false
},
"message": {
"type": "string"
},
"data": {
"type": "object"
}
}
}
}
}
},
"500": {
"description": "Server error",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"success"
],
"properties": {
"success": {
"type": "boolean",
"example": false
},
"message": {
"type": "string"
},
"data": {
"type": "object"
}
}
}
}
}
}
}
}
Примеры по OpenAPI
Сформированы по схеме контроллера; значения полей необходимо заменить.
Пример запроса
curl -k -X PUT "https://{IP_контроллера}/api/v1/security_integration/r3_link/{id}" \
-H "Authorization: Bearer <token>" \
-H "Content-Type: application/json" \
--data-raw '{
"uuid": "string",
"controller": "string",
"status": "ACTIVE",
"state": "ONLINE",
"ip_adr_r3mc": "string",
"udp_port": 1,
"mask": "string",
"ip_adr_strazh": "string",
"config": {
"devices": [
{
"address": 1,
"deviceType": 1,
"description": "string"
}
],
"sec_zones": [
{
"devices": [
{
"address": 1,
"zone": 1
}
],
"address": 1,
"description": "string"
}
]
},
"zones": [
{
"id": 1,
"access_points": [
"string"
],
"status": "string"
}
],
"statistic": [
{
"rx": 1,
"tx": 1,
"link": "string"
}
]
}'
Пример тела запроса
{
"uuid": "string",
"controller": "string",
"status": "ACTIVE",
"state": "ONLINE",
"ip_adr_r3mc": "string",
"udp_port": 1,
"mask": "string",
"ip_adr_strazh": "string",
"config": {
"devices": [
{
"address": 1,
"deviceType": 1,
"description": "string"
}
],
"sec_zones": [
{
"devices": [
{
"address": 1,
"zone": 1
}
],
"address": 1,
"description": "string"
}
]
},
"zones": [
{
"id": 1,
"access_points": [
"string"
],
"status": "string"
}
],
"statistic": [
{
"rx": 1,
"tx": 1,
"link": "string"
}
]
}
Пример ответа
{
"success": false,
"message": "string",
"data": {}
}
PATCH /security_integration/r3_link/{id}
Раздел: Связь R3.
Частично обновляет конфигурацию интеграции R3 Link.
Параметры и ответы по OpenAPI
{
"description": "Update parts of the R3 link integration configuration",
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"uuid": {
"type": "string",
"pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$"
},
"controller": {
"type": "string",
"description": "Серийник контроллера, к которому подключен R3MC"
},
"status": {
"type": "string",
"enum": [
"ACTIVE",
"INACTIVE"
]
},
"state": {
"type": "string",
"enum": [
"ONLINE",
"OFFLINE",
"UNKNOWN"
]
},
"ip_adr_r3mc": {
"type": "string",
"pattern": "^(25[0-5]|2[0-4][0-9]|1[0-9]{2}|[1-9]?[0-9])\\.(25[0-5]|2[0-4][0-9]|1[0-9]{2}|[1-9]?[0-9])\\.(25[0-5]|2[0-4][0-9]|1[0-9]{2}|[1-9]?[0-9])\\.(25[0-5]|2[0-4][0-9]|1[0-9]{2}|[1-9]?[0-9])$",
"description": "IP Адрес R3MC"
},
"udp_port": {
"type": "integer",
"description": "Порт"
},
"mask": {
"type": "string",
"pattern": "^(25[0-5]|2[0-4][0-9]|1[0-9]{2}|[1-9]?[0-9])\\.(25[0-5]|2[0-4][0-9]|1[0-9]{2}|[1-9]?[0-9])\\.(25[0-5]|2[0-4][0-9]|1[0-9]{2}|[1-9]?[0-9])\\.(25[0-5]|2[0-4][0-9]|1[0-9]{2}|[1-9]?[0-9])$",
"description": "Маска подсети"
},
"ip_adr_strazh": {
"type": "string",
"pattern": "^(25[0-5]|2[0-4][0-9]|1[0-9]{2}|[1-9]?[0-9])\\.(25[0-5]|2[0-4][0-9]|1[0-9]{2}|[1-9]?[0-9])\\.(25[0-5]|2[0-4][0-9]|1[0-9]{2}|[1-9]?[0-9])\\.(25[0-5]|2[0-4][0-9]|1[0-9]{2}|[1-9]?[0-9])$",
"description": "IP Адрес от R3MC"
},
"config": {
"type": "object",
"required": [
"devices",
"sec_zones"
],
"properties": {
"devices": {
"type": "array",
"items": {
"type": "object",
"required": [
"address",
"deviceType"
],
"properties": {
"address": {
"type": "integer",
"minimum": 0
},
"deviceType": {
"type": "integer"
},
"description": {
"type": "string"
}
}
}
},
"sec_zones": {
"type": "array",
"items": {
"type": "object",
"required": [
"devices",
"address"
],
"properties": {
"devices": {
"type": "array",
"items": {
"type": "object",
"required": [
"address",
"zone"
],
"properties": {
"address": {
"type": "integer",
"minimum": 0
},
"zone": {
"type": "integer"
}
}
}
},
"address": {
"type": "integer",
"minimum": 0
},
"description": {
"type": "string"
}
}
}
}
}
},
"zones": {
"type": "array",
"items": {
"type": "object",
"required": [
"id",
"access_points"
],
"properties": {
"id": {
"type": "integer",
"minimum": 1,
"description": "Security zone in R3 link"
},
"access_points": {
"type": "array",
"items": {
"type": "string",
"description": "Access points in security zone",
"pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$"
}
},
"status": {
"type": "string",
"description": "zone status from integration"
}
}
}
}
}
}
}
}
},
"responses": {
"200": {
"description": "Successfully patched R3 link configuration",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"success"
],
"properties": {
"success": {
"type": "boolean",
"example": false
},
"message": {
"type": "string"
},
"data": {
"type": "object"
}
}
}
}
}
},
"400": {
"description": "Bad request parameters",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"success"
],
"properties": {
"success": {
"type": "boolean",
"example": false
},
"message": {
"type": "string"
},
"data": {
"type": "object"
}
}
}
}
}
},
"500": {
"description": "Server error",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"success"
],
"properties": {
"success": {
"type": "boolean",
"example": false
},
"message": {
"type": "string"
},
"data": {
"type": "object"
}
}
}
}
}
}
}
}
Примеры по OpenAPI
Сформированы по схеме контроллера; значения полей необходимо заменить.
Пример запроса
curl -k -X PATCH "https://{IP_контроллера}/api/v1/security_integration/r3_link/{id}" \
-H "Authorization: Bearer <token>" \
-H "Content-Type: application/json" \
--data-raw '{
"uuid": "string",
"controller": "string",
"status": "ACTIVE",
"state": "ONLINE",
"ip_adr_r3mc": "string",
"udp_port": 1,
"mask": "string",
"ip_adr_strazh": "string",
"config": {
"devices": [
{
"address": 1,
"deviceType": 1,
"description": "string"
}
],
"sec_zones": [
{
"devices": [
{
"address": 1,
"zone": 1
}
],
"address": 1,
"description": "string"
}
]
},
"zones": [
{
"id": 1,
"access_points": [
"string"
],
"status": "string"
}
]
}'
Пример тела запроса
{
"uuid": "string",
"controller": "string",
"status": "ACTIVE",
"state": "ONLINE",
"ip_adr_r3mc": "string",
"udp_port": 1,
"mask": "string",
"ip_adr_strazh": "string",
"config": {
"devices": [
{
"address": 1,
"deviceType": 1,
"description": "string"
}
],
"sec_zones": [
{
"devices": [
{
"address": 1,
"zone": 1
}
],
"address": 1,
"description": "string"
}
]
},
"zones": [
{
"id": 1,
"access_points": [
"string"
],
"status": "string"
}
]
}
Пример ответа
{
"success": false,
"message": "string",
"data": {}
}
DELETE /security_integration/r3_link/{id}
Раздел: Связь R3.
Удаляет конфигурацию R3 Link.
Параметры и ответы по OpenAPI
{
"description": "Remove r3 link config",
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Successfully removed r3 link config",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"success"
],
"properties": {
"success": {
"type": "boolean",
"example": false
},
"message": {
"type": "string"
},
"data": {
"type": "object"
}
}
}
}
}
},
"500": {
"description": "Server error",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"success"
],
"properties": {
"success": {
"type": "boolean",
"example": false
},
"message": {
"type": "string"
},
"data": {
"type": "object"
}
}
}
}
}
}
}
}
Примеры по OpenAPI
Сформированы по схеме контроллера; значения полей необходимо заменить.
Пример запроса
curl -k -X DELETE "https://{IP_контроллера}/api/v1/security_integration/r3_link/{id}" \
-H "Authorization: Bearer <token>"
Пример ответа
{
"success": false,
"message": "string",
"data": {}
}