AutoMap — rest — writers

GET /daemon/writers

Структура запроса:


GET /daemon/writers?token=mbs90lon2a8

token: ключ доступа

Ответ:

Статус: 200 — успешное выполнение

Формат: json

[{
	"id": 1,
	"host": "8.8.8.8",
	"port": 6941,
	"path": "103.69.14.147",
	"needAuth": false,
	"authUser": null,
	"authPassword": null,
	"reconnectTime": 5,
	"resendAttempts": 3,
	"loggerTimeout": 60,
	"name": "test",
	"incrementId": 0,
	"logLevel": 5,
	"rightId": null,
	"tagId": 121,
	"protocolId": 11
},…]

// id источника отправки данных, целое число
// хост, строка
// порт, целое число
// путь, строка
// требуется ли авторизация, булевое поле
// логин, строка
// пароль, строка
// время переподключения, целое число
// максимальное количество неудачных попыток отправки данных, целое число
// период времени, для которого будет подсчитано и записано в лог количество отправленных сообщений, целое число
// название, строка
// id прав, целое число
// уровень логирования, целое число
// id прав, целое число
// id метки, целое число
// id протокола, целое число

Статус: 500 — ошибка на сервере

Формат: text/plain

Содержит описание ошибки

GET /daemon/writers/{id}

Структура запроса:


GET /daemon/writers/21?token=mbs90lon2a8

id: id источника отправки данных

token: ключ доступа

Ответ:

Статус: 200 — успешное выполнение

Формат: json

{
	"id": 21,
	"host": "18.28.98.108",
	"port": 6941,
	"path": "103.69.14.147",
	"needAuth": false,
	"authUser": null,
	"authPassword": null,
	"reconnectTime": 5,
	"resendAttempts": 3,
	"loggerTimeout": 60,
	"name": "test",
	"incrementId": 0,
	"logLevel": 5,
	"rightId": null,
	"tagId": 121,
	"protocolId": 11
}

// id источника отправки данных, целое число
// хост, строка
// порт, целое число
// путь, строка
// требуется ли авторизация, булевое поле
// логин, строка
// пароль, строка
// время переподключения, целое число
// максимальное количество неудачных попыток отправки данных, целое число
// период времени, для которого будет подсчитано и записано в лог количество отправленных сообщений, целое число
// название, строка
// id прав, целое число
// уровень логирования, целое число
// id прав, целое число
// id метки, целое число
// id протокола, целое число

Статус: 404 — объект не найден

Формат: text/plain

Содержит описание ошибки

Статус: 500 — ошибка на сервере

Формат: text/plain

Содержит описание ошибки

POST /daemon/writers

Структура запроса:


POST /daemon/writers?token=mbs90lon2a8

token: ключ доступа

Пример запроса:

Формат: json

{
	"authPassword": "password",
	"authUser": "login",
	"host": "155.69.187.40",
	"incrementId": 10,
	"logLevel": "5",
	"mappings": [],
	"name": "New writer",
	"needAuth": true,
	"path": "path",
	"port": 6687,
	"protocolId": 11,
	"reconnectTime": 5,
	"resendAttempts": 3,
	"rightId": null,
	"tagId": 1
}

// пароль для авторизации, строка
// логин для авторизации, строка
// хост, строка
// id приращения, строка
// уровень логирования, строка
// картография
// название, строка
// требуется ли авторизация, булевое поле
// путь, строка
// порт, целое число
// id протокола, целое число
// время переподключения, целое число
// максимальное число неудачных попыток, целое число
// id прав, целое число
// id метки, целое число

Ответ:

Статус: 200 — успешное выполнение

Формат: json

{
	"id": 1061,
	"protocol": {
		"id": 11,
		"name": "native",
		"title": "Внутренний формат",
		"listener": true,
		"receiver": false,
		"writer": true,
		"stable": true
	},
	"host": "155.69.187.40",
	"port": 6687,
	"path": "path",
	"right": null,
	"tag": {
		"id": 1,
		"name": "first tag",
		"color": "8fff33"
	},
	"needAuth": true,
	"authUser": "login",
	"authPassword": "password",
	"reconnectTime": 5,
	"resendAttempts": 3,
	"loggerTimeout": 60,
	"name": "New writer",
	"incrementId": 10,
	"logLevel": 5,
	"protocolId": 11,
	"rightId": null,
	"tagId": 1
}

// id источника отправки данных, целое число
// информация о протоколе
// id протокола, целое число
// название протокола, строка
// заголовок, строка
// источник получения данных, булевое поле
// источник сбора данных, булевое поле
// источник отправки данных, булевое поле
// стабильность источника, булевое поле

// хост, строка
// порт, целое число
// путь, строка
// информация о правах
// информация о метках
// id метки, целое число
// название метки, строка
// цвет метки, строка

// требуется ли авторизация, булевое поле
// пользователь, строка
// пароль, строка
// время переподключения, целое число
// максимальное количество неудачных попыток отправки данных, целое число
// период времени, для которого будет подсчитано и записано в лог количество отправленных сообщений
// название, строка
// id приращения, целое число
// уровень логирования, целое число
// id протокола, целое число
// id прав, целое число
// id метки, целое число

Статус: 400 — ошибка в запросе

Формат: text/plain

Содержит описание ошибки

Статус: 500 — ошибка на сервере

Формат: text/plain

Содержит описание ошибки

PUT /daemon/writers/{id}

Структура запроса:


PUT /daemon/writers/20?token=mbs90lon2a8

id: id источника отправки данных

token: ключ доступа

Пример запроса:

Формат: json

{
	"authPassword": "password",
	"authUser": "login",
	"host": "155.69.187.40",
	"id": 1061,
	"incrementId": 10,
	"logLevel": 3,
	"loggerTimeout": 60,
	"mappings": [],
	"name": "New writer",
	"needAuth": true,
	"path": "path",
	"port": 6687,
	"protocol": {
		"id": 11,
		"listener": true,
		"name": "native",
		"receiver": false,
		"stable": true,
		"title": "Внутренний формат",
		"writer": true
	},
	"protocolId": 17,
	"reconnectTime": 5,
	"resendAttempts": 3,
	"right": null,
	"rightId": 2,
	"tag": {
		"color": "8fff33",
		"id": 1,
		"name": "first tag"
	},
	"tagId": null
}

// пароль для авторизации, строка
// логин для авторизации, строка
// хост, строка
// id источника отправки данных, целое число
// id приращения, строка
// уровень логирования, строка
// период времени, для которого будет подсчитано и записано в лог количество отправленных сообщений, целое число
// картография
// название, строка
// требуется ли авторизация, булевое поле
// путь, строка
// порт, целое число
// информация о протоколе
// id протокола, целое число
// источник получения данных, булевое поле
// название, строка
// источник сбора данных, булевое поле
// стабильность протокола, булевое поле
// заголовок, строка
// источник отправки данных, булевое поле

// id протокола, целое число
// время переподключения, целое число
// максимальное число неудачных попыток, целое число
// права, строка
// id права, целое число
// информация о метках
// цвет метки, строка
// id метки, целое число
// название метки, строка

// id метки, строка

Ответ:

Статус: 200 — успешное выполнение

Формат: json

{
	"id": 1061,
	"host": "155.69.187.40",
	"port": 6687,
	"path": "path",
	"needAuth": true,
	"authUser": "login",
	"authPassword": "password",
	"reconnectTime": 5,
	"resendAttempts": 3,
	"loggerTimeout": 60,
	"name": "New writer",
	"incrementId": 10,
	"logLevel": 3,
	"protocolId": 17,
	"rightId": 2,
	"tagId": null
}

// id источника отправки данных, целое число
// хост, строка
// порт, целое число
// путь, строка
// требуется ли авторизация, булевое поле
// пользователь, строка
// пароль, строка
// время переподлкючения, целое число
// максимальное количество неудачных попыток отправки данных, целое число
// период времени, для которого будет подсчитано и записано в лог количество отправленных сообщений
// название, строка
// id приращения, целое число
// уровень логирования, целое число
// id протокола, целое число 
// id прав, целое число
// id метки, целое число

Статус: 400 — ошибка в запросе

Формат: text/plain

Содержит описание ошибки

Статус: 404 — объект не найден

Формат: text/plain

Содержит описание ошибки

Статус: 500 — ошибка на сервере

Формат: text/plain

Содержит описание ошибки

DELETE /daemon/writers/{id}

Структура запроса:


DELETE /daemon/writers/6?token=mbs90lon2a8

id: id источника отправки данных

token: ключ доступа

Ответ:

Статус: 200 — успешное выполнение

Формат: json

{
    "delete":true
}

Статус: 500 — ошибка на сервере

Формат: text/plain

Содержит описание ошибки

GET /daemon/writers/count

Структура запроса:


GET /daemon/writers/count?token=mbs90lon2a8

token: ключ доступа

Ответ:

Статус: 200 — успешное выполнение

Формат: json


17


// количество источников отправки данных

Статус: 500 — ошибка на сервере

Формат: text/plain

Содержит описание ошибки