Skip to content

Структуры данных

Response

Объект ответа от API Эсборд.

Содержит следующие поля:

НазваниеОписаниеОбязательный
statusСтатус ответа.Да
dataОбъект, содержащий результат запроса или подробности об ошибке.Нет
errorСообщение об ошибке.Нет

Response status

Числовое значение, определяющее успешность запроса.

Допустимые значения:

ЗначениеОписание
0Успех
1Ошибка

Drawing

Элемент доски.

Свойства:

НазваниеОписаниеОбязательный
idИдентификатор элемента.Да
modeТип элемента.Да
textPayloadТекстовая информация элемента.Нет
graphicsPayloadГрафическая информация элемента.Да
graphicsPropsГрафические свойства элемента.Да
incIdЧисловое значение, соответствующее элементу. Используется для пагинации.Да
frameIdИдентификатор фрейма, к которому прикреплён элемент.Нет, требует запроса с флагом withFrameId
boardИдентификатор доски, на которой расположен элемент.Да
linkSrcЗначение ссылки, установленной на элемент.Нет
Пример объекта Drawing
json
{
  "id": "b6b60e1b-f7ef-4065-9c1f-398c326e487f",
  "mode": "rectangle",
  "textPayload": {
    "textOps": [
      {
        "insert": "Default text, "
      },
      {
        "insert": "styled text",
        "attributes": {
          "color": "#90be6d",
          "italic": true
        }
      },
      {
        "insert": "\n"
      }
    ]
  },
  "graphicsPayload": {
    "position": {
      "x": 581.8920288085938,
      "y": 360.9859924316406
    },
    "graphicsParams": {}
  },
  "graphicsProps": {
    "color": "#000000",
    "fillColor": "#00000000"
  },
  "incId": 64,
  "frameId": "938c8ee2-8f41-4c81-9d59-e3bd3d00b2da",
  "board": "a4728a3f-514e-4be5-b98d-bd014d09cfa6"
}

Drawing modes

Перечисление, определяющее тип элемента доски.

Допустимые значения:

ЗначениеОписание
stickerСтикер
textТекст
imageИзображение
frameФрейм
pencilКарандаш
lineЛиния
bezierCurveКривая линия
polyLineЛоманая линия
rectangleПрямоугольник
roundedRectangleОкруглённый прямоугольник
ellipseЭллипс
triangleТреугольник
rhombusРомб
hexagonШестиугольник

Drawing text payload

Объект, содержащий текстовую информацию элемента доски.

Свойства:

НазваниеОписаниеОбязательный
textOpsМассив фрагментов текста.Нет

Свойства фрагмента текста:

НазваниеОписаниеОбязательный
insertТекст фрагмента.Да
attributesАтрибуты фрагмента.Нет

Свойства атрибутов фрагмента текста:

НазваниеОписаниеОбязательный
colorЦвет фрагмента текста.Нет
boldЛогическое значение. Определяет, является ли фрагмент текста жирным. Значение по умолчанию: false.Нет
italicЛогическое значение. Определяет, является ли фрагмент текста курсивом. Значение по умолчанию: false.Нет
underlineЛогическое значение. Определяет, является ли фрагмент текста подчеркнутым. Значение по умолчанию: false.Нет
Пример объекта Drawing text payload
json
{
  "textOps": [
    {
      "insert": "Default text, "
    },
    {
      "insert": "styled text",
      "attributes": {
        "color": "#90be6d",
        "italic": true
      }
    },
    {
      "insert": "\n"
    }
  ]
}

Drawing graphics payload

Объект, содержащий графическую информацию элемента доски.

Свойства:

НазваниеОписаниеОбязательный
positionКоординаты элемента на доске. Представляет собой объект с полями x и y.Да
graphicsParamsДополнительные графические параметры. Используется для фреймов и представляет собой объект с полем label (заголовок фрейма).Нет
Пример объекта Drawing graphics payload
json
{
  "position": {
    "x": 580.3920288085938,
    "y": 352.9859924316406
  },
  "graphicsParams": {
    "label": "Frame title"
  }
}

Drawing graphics props

Объект, содержащий графические свойства элемента доски.

Свойства:

НазваниеОписаниеОбязательный
colorОсновной цвет элемента.
Для фигур фреймов - цвет рамки.
Для стикеров - цвет стикера.
Да
fillColorЦвет заливки элемента.Да
Пример объекта Drawing graphics props
json
{
  "color": "#90BE6D",
  "fillColor": "#F58176"
}