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

• GET /boards/getDrawings
  • Параметры
  • Ответ
  • Примеры ответов
• POST /boards/setDrawingWebLink
  • Параметры
  • Ответ
  • Примеры ответов
• POST /boards/createBoard
  • Параметры
  • Ответ
  • Примеры ответов
• POST /boards/setBoardTitle
  • Параметры
  • Ответ
  • Примеры ответов
• GET /boards/getBoardMembers
  • Параметры
  • Ответ
  • Примеры ответов
• POST /boards/setBoardMember
  • Параметры
  • Ответ
  • Примеры ответов
• GET /users/getUsers
  • Параметры
  • Ответ
  • Примеры ответов
• POST /users/createUser
  • Параметры
  • Ответ
  • Примеры ответов
• POST /users/deleteUser
  • Параметры
  • Ответ
  • Примеры ответов
• POST /users/updateUser
  • Параметры
  • Ответ
  • Примеры ответов
• POST /teams/createTeam
  • Параметры
  • Ответ
  • Примеры ответов
• POST /teams/changeTeamOwner
  • Параметры
  • Ответ
  • Примеры ответов
• POST /teams/addTeamMember
  • Параметры
  • Ответ
  • Примеры ответов
• POST /teams/removeTeamMember
  • Параметры
  • Ответ
  • Примеры ответов

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

{
  "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

{
  "status": 0
}

Пример ответа 400 - Unsupported drawing

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

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

POST /boards/createBoard

Создать доску в одном из следующих расположений:

• в личном пространстве пользователя
• в папке личного пространства пользователя
• в командном пространстве, участником которого является пользователь
• в папке командного пространства, участником которого является пользователь

Примечание

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

Параметры

Название	Описание	Обязательный
userId	Идентификатор владельца новой доски.	Да
folderId	Идентификатор папки, в которой будет создана доска.	Нет
teamId	Идентификатор команды, в пространстве которой будет создана доска.	Нет
title	Название доски.	Нет

Примечание

При создании доски в папке командного пространства teamId указывать необязательно.

Ответ

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

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

Пример ответа 201 - Created

{
  "status": 0,
  "data": {
    "boardId": "0b1e9480-1ea3-4a67-92e0-a6dfaf7a5c47"
  }
}

Пример ответа 404 - User not found

Попытка создать доску для несуществующего пользователя.

{
  "status": 1,
  "error": "User not found"
}

Пример ответа 403 - Forbidden by user role

Попытка создать доску для пользователя, который не имеет права создавать доски в силу ограничений своей роли.

{
  "status": 1,
  "error": "Forbidden by user role"
}

Пример ответа 404 - Team not found

Команда не найдена.

{
  "status": 1,
  "error": "Team not found"
}

Пример ответа 403 - User is not team member

Попытка создать доску в командном пространстве для пользователя, который не является участником указанной команды.

{
  "status": 1,
  "error": "User is not team member"
}

Пример ответа 403 - User is not folder owner

Попытка создать доску для пользователя в папке личного пространства, которая не принадлежит указанному пользователю.

{
  "status": 1,
  "error": "User is not folder owner"
}

Пример ответа 404 - Folder not found

Попытка создать доску в несуществующей папке.

{
  "status": 1,
  "error": "Folder not found"
}

Пример ответа 400 - Specified teamId doesn't match with folder's teamId

Конфликтная ситуация, когда указаны teamId и folderId и при этом папка не находится в пространстве указанной команды.

{
  "status": 1,
  "error": "Specified teamId doesn't match with folder's teamId"
}

POST /boards/setBoardTitle

Обновить название доски.

Примечание

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

Параметры

Название	Описание	Обязательный
boardId	Идентификатор доски.	Да
title	Название доски.	Да

Ответ

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

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

Пример ответа 200 - OK

{
  "status": 0
}

Пример ответа 404 - Board not found

Попытка обновить название несуществующей доски.

{
  "status": 1,
  "error": "Board not found"
}

GET /boards/getBoardMembers

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

Примечание

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

Параметры

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

Ответ

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

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

Пример ответа 200 - OK

{
  "status": 0,
  "data": {
    "members": [
      {
        "incId": 921,
        "userId": 33,
        "role": "spectator",
        "name": "Test employee",
        "color": "#FFB18E",
        "accessRestricted": false
      }
    ],
    "count": 1,
    "nextIncId": 921
  }
}

POST /boards/setBoardMember

Установить или обновить неанонимного участника на доске. Метод предназначен для присоединения пользователей к доскам и выдаче им необходимых прав доступа без участия самих пользователей. Метод не допускает редактирование владельца доски.

Примечание

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

Параметры

Название	Описание	Обязательный
boardId	Идентификатор доски.	Да
userId	Числовой идентификатор пользователя.	Да
role	Роль участника на доске. Допустимы любые значения за исключением роли владельца. Значение по умолчанию для новых участников: роль новых участников, установленная владельцем в настройках доски. Значение по умолчанию для существующих участников: отсутствует (значение роли не обновляется).	Нет
accessRestricted	Логическое значение. Определяет, будет ли заблокирован участник после выполнения метода. Значение по умолчанию: false.	Нет

Ответ

Название	Описание	Обязательный
status	Статус ответа.	Да
data	Объект, содержащий результат запроса в поле result. Допустимые значения поля: Created, Updated, Actual.	Да, в случае успеха

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

Пример ответа 200 - OK

{
  "status": 0,
  "data": {
    "result": "Created"
  }
}

Пример ответа 404 - Board not found

Указанная доска не существует.

{
  "status": 1,
  "error": "Board not found"
}

Пример ответа 404 - User not found

Указанный пользователь не существует.

{
  "status": 1,
  "error": "User not found"
}

Пример ответа 403 - Forbidden by user role

Пользователь не имеет права работать на досках в силу ограничений своей роли.

{
  "status": 1,
  "error": "Forbidden by user role"
}

Пример ответа 403 - User is board owner

Изменять данные владельца запрещено.

{
  "status": 1,
  "error": "User is board owner"
}

Пример ответа 400 - Invalid member role

Указанная роль не является допустимым значением.

{
  "status": 1,
  "error": "Invalid member role"
}

GET /users/getUsers

Получить список пользователей системы.

Примечание

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

Параметры

Название	Описание	Обязательный
pageToken	Значение, используемое для пагинации. Содержит значение параметра take, переданного в предыдущем запросе. Значение может быть переопределено новым параметром take.	Нет
take	Максимальное число элементов, которое может вернуть запрос. Максимальное значение и значение по умолчанию: 200. Переопределяет значение take, содержащееся в pageToken.	Нет

Ответ

Название	Описание	Обязательный
status	Статус ответа.	Да
data	Объект, содержащий результат запроса (см. ниже).	Да, в случае успеха
data.users	Массив пользователей.	Да, если число возвращаемых объектов больше 0
data.count	Число пользователей в массиве data.users.	Да
data.nextPageToken	Значение pageToken для получения следующей страницы.	Да, если число возвращаемых объектов больше 0

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

Пример ответа 200 - OK

{
  "status": 0,
  "data": {
    "users": [
      {
        "id": 2,
        "email": "example@example.example",
        "role": "CREATOR",
        "name": "Username"
      }
    ],
    "count": 1,
    "nextPageToken": "MTA6Mg"
  }
}

POST /users/createUser

Создать нового пользователя в системе.

Примечание

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

Параметры

Название	Описание	Обязательный
name	Имя пользователя.	Да
email	E-mail пользователя.	Да
password	Пароль пользователя.	Да
role	Роль пользователя. Допустимы любые значения за исключением роли администратора. Значение по умолчанию: роль новых пользователей, установленная администратором.	Нет

Ответ

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

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

Пример ответа 201 - Created

{
  "status": 0,
  "data": {
    "userId": 2
  }
}

Пример ответа 400 - Invalid user role

Указанная роль не является допустимым значением.

{
  "status": 1,
  "error": "Invalid user role"
}

Пример ответа 409 - User already exists

Пользователь с указанным e-mail уже существует.

{
  "status": 1,
  "error": "User already exists"
}

Пример ответа 403 - License is expired

Срок действия лицензии истёк, операции с пользователями, имеющими роль создателя, ограничены.

{
  "status": 1,
  "error": "License is expired"
}

Пример ответа 403 - Max creators count is reached

Невозможно создать пользователя, поскольку достигнут лимит лицензии по количеству создателей.

{
  "status": 1,
  "error": "Max creators count is reached"
}

POST /users/deleteUser

Удалить пользователя из системы. Пользователь не должен иметь роль администратора.

Примечание

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

Параметры

Название	Описание	Обязательный
userId	Идентификатор пользователя.	Да

Ответ

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

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

Пример ответа 200 - OK

{
  "status": 0
}

Пример ответа 404 - User not found

Попытка удалить пользователя, которого нет в системе.

{
  "status": 1,
  "error": "User not found"
}

Пример ответа 403 - Forbidden by user role

Удалять пользователей с ролью администратора запрещено.

{
  "status": 1,
  "error": "Forbidden by user role"
}

POST /users/updateUser

Обновить данные пользователя системы.

Примечание

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

Параметры

Название	Описание	Обязательный
userId	Идентификатор пользователя.	Да
name	Новое имя пользователя.	Нет
email	Новый e-mail пользователя.	Нет
password	Новый пароль пользователя.	Нет
role	Новая роль пользователя. Допустимы любые значения за исключением роли администратора.	Нет

Примечание

Для администратора по умолчанию (пользователь с e-mail admin@admin.admin) доступна только смена пароля.

Ответ

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

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

Пример ответа 200 - OK

{
  "status": 0
}

Пример ответа 400 - Invalid user role

Указанная роль не является допустимым значением.

{
  "status": 1,
  "error": "Invalid user role"
}

Пример ответа 404 - User not found

Попытка обновить пользователя, которого нет в системе.

{
  "status": 1,
  "error": "User not found"
}

Пример ответа 400 - No data to update

Не указано данных для обновления.

{
  "status": 1,
  "error": "No data to update"
}

Пример ответа 403 - License is expired

Срок действия лицензии истёк, операции с пользователями, имеющими роль создателя, ограничены.

{
  "status": 1,
  "error": "License is expired"
}

Пример ответа 403 - Max creators count is reached

Невозможно создать пользователя, поскольку достигнут лимит лицензии по количеству создателей.

{
  "status": 1,
  "error": "Max creators count is reached"
}

Пример ответа 409 - User already exists

Пользователь с указанным e-mail уже существует.

{
  "status": 1,
  "error": "User already exists"
}

Пример ответа 403 - Forbidden by user role

Запрещено менять данные администратора за исключением пароля.

{
  "status": 1,
  "error": "Forbidden by user role"
}

POST /teams/createTeam

Создать команду от имени пользователя. Пользователь должен иметь роль создателя.

Примечание

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

Параметры

Название	Описание	Обязательный
userId	Идентификатор владельца команды.	Да
title	Название команды. Значение по умолчанию: Новая команда.	Нет

Ответ

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

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

Пример ответа 201 - Created

{
  "status": 0,
  "data": {
    "teamId": 2
  }
}

Пример ответа 404 - User not found

Попытка добавить пользователя, которого нет в системе.

{
  "status": 1,
  "error": "User not found"
}

Пример ответа 403 - Forbidden by user role

Пользователь не имеет роль создателя.

{
  "status": 1,
  "error": "Forbidden by user role"
}

POST /teams/changeTeamOwner

Изменить владельца команды.

Примечание

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

Параметры

Название	Описание	Обязательный
teamId	Идентификатор команды.	Да
newOwnerUserId	Идентификатор нового владельца команды. Если команда была без владельца, то командные доски и папки предыдущего владельца команды перейдут к новому владельцу.	Да

Ответ

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

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

Пример ответа 200 - OK

{
  "status": 0
}

Пример ответа 404 - Team not found

Команда не найдена.

{
  "status": 1,
  "error": "Team not found"
}

Пример ответа 403 - User is not team member

Попытка передать команду пользователю, который не является участником команды.

{
  "status": 1,
  "error": "User is not team member"
}

POST /teams/addTeamMember

Добавить пользователя в команду. Пользователь должен иметь роль создателя.

Примечание

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

Параметры

Название	Описание	Обязательный
teamId	Идентификатор команды.	Да
userId	Идентификатор пользователя, добавляемого в команду.	Да

Ответ

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

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

Пример ответа 200 - OK

{
  "status": 0
}

Пример ответа 404 - User not found

Попытка добавить пользователя, которого нет в системе.

{
  "status": 1,
  "error": "User not found"
}

Пример ответа 403 - Forbidden by user role

Пользователь не имеет роль создателя.

{
  "status": 1,
  "error": "Forbidden by user role"
}

Пример ответа 404 - Team not found

Команда не найдена.

{
  "status": 1,
  "error": "Team not found"
}

Пример ответа 409 - User already a team member

Пользователь уже является участником команды.

{
  "status": 1,
  "error": "User already a team member"
}

POST /teams/removeTeamMember

Удалить пользователя из команды.

Примечание

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

Параметры

Название	Описание	Обязательный
teamId	Идентификатор команды.	Да
userId	Идентификатор пользователя, удаляемого из команды.	Да
newOwnerUserId	Идентификатор участника команды, который станет владельцем командных досок и папок удаляемого участника. Значение по умолчанию: идентификатор последнего владелеца команды.	Нет

Ответ

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

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

Пример ответа 200 - OK

{
  "status": 0
}

Пример ответа 404 - Team not found

Команда не найдена.

{
  "status": 1,
  "error": "Team not found"
}

Пример ответа 403 - User is not team member

Попытка удалить из команды пользователя, который не является участником команды.

{
  "status": 1,
  "error": "User is not team member"
}

Пример ответа 403 - User is not team member (new owner)

Новый владелец командных досок и папок удаляемого участника не является участником команды. Данная ошибка не распространяется на ситуацию, когда у команды нет владельца и параметр newOwnerUserId не указан.

{
  "status": 1,
  "error": "User is not team member (new owner)"
}