Skip to content
JSON API
Формат API-сообщений
Каждое сообщение WBS имеет постоянный заголовок:
Имя
Тип
Описание
Примечание
server
string
Уникальный идентификатор сервера.
id
number
Уникальный идентификатор транзакции отличный от -1. Назначается отправителем. Применяется для request и response. Применяется для идентификации ответа (response) клиентом после отправки запроста (request).
классов
Опционально
result
Результат выпонения транзакции. Назначается только для класса response. Может принимать, 200 (ok), 207 (multy-status) или 400 (bad-request). Данный статус торажает только состяние
Только для типа response
There are no rows in this table
Сообщения типов request, response и notification, помимо заголовка имеют обязательное дополнительное поле methods:
Имя
Тип
Описание
Примечание
methods
Массив объектов с описанием вызываемых методов. Запросы содержат параметры методов, ответы - результаты их выполнения. Методы выполняются сервером строго в порядке расположения в массиве.
There are no rows in this table
Имя
Тип
Описание
Примечание
state
enum
Состояние сервера:
up - сервер запущен;
down - сервер остановлен;
failed - ошибка сервера;
reason
string
Для state = failed содержит причину внутренней ошибки
Опционально
There are no rows in this table
Want to print your doc?
This is not the way.
This is not the way.
Try clicking the ⋯ next to your doc name or using a keyboard shortcut (
CtrlP
) instead.