Skip to content

Список методов

GET /boards/getDrawings

Получить все элементы доски.

Примечание

Доступно с версии 2024.5.

Параметры

НазваниеОписаниеОбязательный
boardIdИдентификатор доски.Да
modesМассив типов элементов, которые должен вернуть запрос. Если не указано, то сервер возвращает все элементы.Нет
incIdЧисловое значение, используемое для пагинации. Метод возвращает объекты с incId больше указанного. Значение по умолчанию: 0.Нет
takeМаксимальное число элементов, которое может вернуть запрос. Максимальное значение и значение по умолчанию: 200.Нет
withFrameIdЛогический флаг. Определяет, нужно ли при ответе включать в объекты элементов поле frameId. Значение по умолчанию: false.Нет

Ответ

НазваниеОписаниеОбязательный
statusСтатус ответа.Да
dataОбъект, содержащий результат запроса (см. ниже) или подробности об ошибке.Да, в случае успеха
data.drawingsМассив элементов.Да, если число возвращаемых объектов больше 0
data.countЧисло элементов в массиве data.drawings.Да
data.nextIncIdСледующий incId. Равен incId последнего элемента в массиве data.drawings.Да, если число возвращаемых объектов больше 0

Примеры ответов

Пример ответа 200 - OK
json
{
  "status": 0,
  "data": {
    "drawings": [
      {
        "id": "938c8ee2-8f41-4c81-9d59-e3bd3d00b2da",
        "mode": "frame",
        "textPayload": {},
        "graphicsPayload": {
          "position": {
            "x": 580.3920288085938,
            "y": 352.9859924316406
          },
          "graphicsParams": {
            "label": "Frame title"
          }
        },
        "graphicsProps": {
          "color": "#90BE6D",
          "fillColor": "#F58176"
        },
        "incId": 63,
        "board": "a4728a3f-514e-4be5-b98d-bd014d09cfa6"
      },
      {
        "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"
      }
    ],
    "count": 2,
    "nextIncId": 64
  }
}

POST /boards/setDrawingWebLink

Обновить ссылку на элементе доски.

Примечание

Доступно с версии 2024.5.

Параметры

НазваниеОписаниеОбязательный
drawingIdИдентификатор элемента.Да
linkSrcНовое значение ссылки. Если не указано, то происходит удаление ссылки с элемента.Нет

Ответ

НазваниеОписаниеОбязательный
statusСтатус ответа.Да

Примеры ответов

Пример ответа 200 - OK
json
{
  "status": 0
}
Пример ответа 400 - Unsupported drawing

Попытка установить ссылку на элемент доски, неподдерживающий ссылки.

json
{
  "status": 1,
  "error": "Unsupported drawing"
}