Для работы с объектами используются следующие методы:
•GET — для получения данных.
•POST — для добавления данных.
•PUT — для изменения данных.
•DELETE — для удаления данных.
|
---|
Порядок действий:
1.Найдите нужный объект в общем списке объектов.
2.Найдите нужный метод объекта.
3.Заполните параметры метода, если они есть. Если для параметра есть схема, то по щелчку на поле со схемой она будет скопирована в поле со значением параметра. В эту схему подставьте правильные значения (см. пример ниже).
Порядок работы с методом объекта (1-ая часть).
Пример заполнения параметра для создания задачи
Задача создается в категории с ID=123 от имени системного пользователя с ID=1. Исполнители не назначаются. В категории настроены ДП "Имя" ID=1111, Email ID=2222, "Телефон" ID=3333, "Комментарий" ID=4444. { |
4.Когда все параметры заполнены, нажмите на кнопку "Try it out!".
5.Ниже будет сформирован адрес (URL) для вызова метода, а также отобразятся результаты вызова сервиса (например, номер созданной задачи и пр.), чтобы вы могли убедиться в правильности ваших настроек или проанализировать ошибки. В поле Response Code значение 200 означает корректное выполнение вызова, а 500 — ошибку.
Порядок работы с методом объекта (2-ая часть).
|
---|
Наиболее используемые API методы
Agenda (Повестка дня)
Возвращает повестку дня пользователя в диапазоне |
|||
---|---|---|---|
Параметр |
Формат |
Описание |
|
userId |
integer |
Пользователь, чья повестка дня запрашивается. При пустом значении (null), берется идентификатор сессионного пользователя. |
|
subcatIds |
array |
Фильтр категорий. |
|
catIds |
array |
Фильтр разделов. |
|
dateTo |
string |
Окончание диапазона. При пустом значении (null) диапазон равен началу сегодняшнего дня. |
|
dateFrom |
string |
Начало диапазона. При пустом значении (null) диапазон равен окончанию сегодняшнего дня. |
|
includes |
array |
Что включать в запрос повестки дня. Возможные значения: ["events", "tasks", "signatures", "reminders", "providersEvents"]. По умолчанию providersEvents. |
|
|
Получить письмо |
||
---|---|---|
Параметр |
Формат |
Описание |
emailId |
integer |
Уникальный идентификатор письма |
Массовое удаление писем из почтовой папки |
|||
---|---|---|---|
Параметр |
Формат |
Описание |
|
emailIds |
array |
Список id писем |
|
folderId |
integer |
Уникальный идентификатор почтовой папки |
|
fromSearchFolder |
boolean |
Из папки поиска |
|
|
Аутентификация
Получить информацию для авторизации (по текущему пользователю) |
|||
---|---|---|---|
|
POST /api/auth/{userId}/impersonate
Перевоплщение в пользователя |
||
---|---|---|
Параметр |
Формат |
Описание |
userId |
integer |
Уникальный идентификатор пользователя, в которого необходимо перевоплотиться |
POST /api/auth/{userId}/stopimpersonate
Прекратить перевоплощение |
||
---|---|---|
Параметр |
Формат |
Описание |
userId |
integer |
Уникальный идентификатор пользователя, перевоплощение в которого необходимо прекратить |
Запрос нового токена по refresh-токену. Доступен только из аутентифицированного контекста (с валидным access-токеном) |
||
---|---|---|
Параметр |
Формат |
Описание |
refreshToken |
string |
refresh-токен |
Метод может работать анонимно |
Группы
Получить пользователей, входящих в группу |
|||||
---|---|---|---|---|---|
Параметр |
Формат |
Описание |
|||
groupId |
integer |
Уникальный идентификатор группы |
|||
|
Задачи
GET /app/v1.0/api/subcategories/tree
Возвращает список категорий для текущего пользователя. |
|||||
---|---|---|---|---|---|
Параметр |
Формат |
Описание |
|||
allTasksCount |
integer |
Общее количество задач в категории |
|||
newTasksCount |
integer |
Количество новых задач |
|||
overdueTasksCount |
integer |
Количество просроченных задач |
|||
allTasksUserOwns |
integer |
Количество задач, в которых текущий пользователь является заказчиком |
|||
allTasksUserPerforms |
integer |
Количество задач, в которых текущий пользователь является исполнителем |
|||
parentId |
integer |
Идентификатор родительской категории |
|||
nodeType |
string |
Тип. Варианты значений: Category, Subcategory |
|||
isDictionary |
boolean |
Является словарем |
|||
isSpace |
boolean |
Является пространством |
|||
canEdit |
boolean |
Можно редактировать |
|||
openType |
string |
Представление категории. Варианты значений: feed, grid, additionalsyndicate, filebrowser_thumbnailsview, kanban. |
|||
portalId |
integer |
Идентификатор портала |
|||
canCreateTask |
boolean |
Право создавать задачи |
|||
details |
string |
Описание категории |
|||
availableRepresentations |
array |
Массив объектов доступных представлений категории. Варианты значений: Grid, Feeds, Calendar, Gantt, Kanban, Channel, Chat, Files |
|||
name |
string |
Наименование категории |
|||
id |
integer |
Идентификатор категории |
|||
total |
integer |
Общее количество |
|||
|
Получить задачу |
|||||
---|---|---|---|---|---|
Параметр |
Формат |
Описание |
|||
id |
integer |
Номер задачи |
|||
|
GET /api/tasks/{taskId}/actions
Получить доступные действия для задачи. Включены пошаговые и пользовательские кнопки. |
|||||
---|---|---|---|---|---|
Параметр |
Формат |
Описание |
|||
taskId |
integer |
Номер задачи |
|||
|
GET /app/v1.0/api/tasks/{taskId}/mainroute
Метод для получения основного маршрута по задаче и доступных пользователю переходов из текущего статуса |
|||||
---|---|---|---|---|---|
Параметр |
Формат |
Описание |
|||
taskId |
integer |
Номер задачи |
|||
|
GET /api/tasks/check-exist-and-access/{taskId}
Проверить задачу на существование и доступ |
|||||
---|---|---|---|---|---|
Параметр |
Формат |
Описание |
|||
taskId |
integer |
Номер задачи |
|||
|
GET /api/tasks/{taskId}/states
Получить статусы задачи |
|||||
---|---|---|---|---|---|
Параметр |
Формат |
Описание |
|||
taskId |
integer |
Номер задачи |
|||
|
Отдает аватар задачи, если он есть |
||
---|---|---|
Параметр |
Формат |
Описание |
taskId |
integer |
Номер задачи |
scaleX |
integer |
Ось X |
scaleY |
integer |
Ось Y |
fullImg |
boolean |
Полное изображение |
enlargeImage |
boolean |
Увеличить изображение |
doNotSendDefaultAvatar |
boolean |
Не отправлять аватар по умолчанию |
GET /api/tasks/linked/{taskId}
Получить связанные задачи |
|||||
---|---|---|---|---|---|
Параметр |
Формат |
Описание |
|||
taskId |
integer |
Номер родительской задачи |
|||
|
GET /api/tasks/subtasks/removelink/{taskId}/{subtaskId}
Разорвать связь с задачей |
||
---|---|---|
Параметр |
Формат |
Описание |
taskId |
integer |
Номер родительской задачи |
subtaskId |
integer |
Задача для удаления |
POST /app/v1.2/api/tasks/feeds
Получить ленту задач |
|||
---|---|---|---|
Параметр |
Формат |
Описание |
|
limit |
integer |
Размер страницы |
|
offset |
integer |
Количество пропускаемых элементов при генерации страницы |
|
subcatId |
integer |
Уникальный идентификатор категории |
|
catId |
integer |
|
|
startTime |
string |
Дата начала |
|
endTime |
string |
Дата окончания |
|
taskParamFilter |
array |
Массив объектов |
|
feedTypes |
array |
Массив объектов |
|
extParamFilters |
string |
|
|
|
Получить ленту задач |
|||
---|---|---|---|
Параметр |
Формат |
Описание |
|
resultRowsCount |
integer |
Количество выводимых строк |
|
resultSetOffset |
integer |
Количество пропускаемых элементов при генерации страницы |
|
include |
array |
Массив объектов для отображения. Пример: ДП ("ExtParams"), комментарии ("CommentCounters"), подписчики ("Subscribers") |
|
showLastComment |
boolean |
Показывать последний комментарий |
|
openOnlyF |
boolean |
Задачи в активном статусе |
|
closedOnlyF |
boolean |
Закрытые задачи |
|
favoritesOnlyF |
boolean |
Избранные задачи |
|
taskHelperOnlyF |
boolean |
Задачи, где пользователь исполнитель |
|
subscriberOnlyF |
boolean |
Задачи, где пользователь подписчик |
|
|
Получить информацию о задаче с некоторыми информационными частями |
|||
---|---|---|---|
Параметр |
Формат |
Описание |
|
taskId |
integer |
Номер задачи |
|
selectedInfoParts |
array |
Массив данных — информационные части. Пример: ДП ("ExtParams") |
|
|
Создать задачу |
|||
---|---|---|---|
Параметр |
Формат |
Описание |
|
subcatId |
integer |
Идентификатор категории, в которой необходимо создать задачу |
|
taskText |
string |
Текст задачи |
|
orderedTime |
string |
Дата создания |
|
priorityId |
integer |
Приоритет. Низкий приоритет — 0; обычный — 1; высокий — 3. |
|
userToMakeOwnerId |
integer |
Идентификатор заказчика задачи |
|
addToFavourites |
boolean |
Добавить задачу в избранное |
|
extParams |
array |
Список ДП |
|
subscriberIds |
array |
Список подписчиков задачи |
|
notifyIds |
array |
Список пользователей, уведомлённых о создании задачи |
|
parentTaskId |
integer |
Родительская задача |
|
linkedTaskId |
integer |
Связанная задача |
|
|
Добавить задачу в избранное |
|||
---|---|---|---|
Параметр |
Формат |
Описание |
|
taskId |
integer |
Номер задачи, которую необходимо добавить в избранное |
|
color |
string |
Цвет текста задачи после добавления в избранное |
|
favsFolderId |
integer |
Идентификатор папки избранного |
|
|
Удалить список задач |
|||
---|---|---|---|
Параметр |
Формат |
Описание |
|
taskIDs |
array |
Список номеров задач, которые необходимо удалить |
|
initiatorUserId |
integer |
Пользователь от имени которого выполнится удаление |
|
|
POST /api/tasks/{taskId}/set-priority
Изменить приоритет задачи |
|||
---|---|---|---|
Параметр |
Формат |
Описание |
|
TaskId |
integer |
Номер задачи, в которой необходимо изменить приоритет |
|
priority |
string |
Низкий приоритет — Low; обычный — Normal; высокий — High. |
|
|
POST /api/tasks/{taskId}/lock-due-date
Заблокировать срок исполнения |
||
---|---|---|
Параметр |
Формат |
Описание |
taskId |
integer |
Номер задачи |
POST /api/tasks/{taskId}/unlock-due-date
Разблокировать срок исполнения |
||
---|---|---|
Параметр |
Формат |
Описание |
taskId |
integer |
Номер задачи |
POST /api/tasks/{taskId}/change-duedate
Изменить срок задачи |
|||
---|---|---|---|
Параметр |
Формат |
Описание |
|
taskId |
integer |
Номер задачи |
|
newDate |
string |
Новый срок |
|
reason |
string |
Причина смены срока |
|
addToQuickReply |
boolean |
Добавить в быстрый ответ |
|
initiatorUserId |
integer |
Идентификатор пользователя-инициатора |
|
|
POST /api/tasks/{taskId}/change-subscribers
Добавить и/или удалить подписчиков в задачу |
|||
---|---|---|---|
Параметр |
Формат |
Описание |
|
taskId |
integer |
Номер задачи |
|
addUsers |
array |
Идентификаторы пользователей, которые нужно добавить подписчиками в задачу |
|
removeUsers |
array |
Идентификаторы пользователей, которых нужно удалить из подписчиков задачи |
|
addGroups |
array |
Идентификаторы групп, пользователей которых нужно добавить подписчиками в задачу |
|
removeGroups |
array |
Идентификаторы групп, пользователей из которых нужно удалить из подписчиков задачи |
|
initiatorUserId |
integer |
Идентификатор пользователя-инициатора действия |
|
|
POST /api/tasks/{taskId}/remove-all-subscribers
Удалить всех подписчиков |
||
---|---|---|
Параметр |
Формат |
Описание |
taskId |
integer |
Номер задачи |
initiatorUserId |
integer |
Идентификатор пользователя-инициатора действия |
POST /api/tasks/{taskId}/change-performers
Сменить исполнителей задачи |
|||
---|---|---|---|
Параметр |
Формат |
Описание |
|
taskId |
integer |
Номер задачи |
|
add |
array |
Идентификаторы пользователей, которых нужно добавить исполнителями задачи |
|
remove |
array |
Идентификаторы пользователей, которых нужно удалить из исполнителей задачи |
|
initiatorUserId |
integer |
Идентификатор пользователя-инициатора действия |
|
|
POST /api/tasks/{taskId}/responsible-performer/{userId}
Назначить исполнителя отвественным |
|||
---|---|---|---|
Параметр |
Формат |
Описание |
|
taskId |
integer |
Номер задачи |
|
userId |
integer |
Идентификаторы пользователя, которого нужно назначить ответственным исполнителем |
|
initiatorUserId |
integer |
Идентификатор пользователя-инициатора действия |
|
|
POST /api/tasks/{taskId}/pin-as-chat-to-all-users
Закрепить всем задачу как чат |
||
---|---|---|
Параметр |
Формат |
Описание |
taskId |
integer |
Номер задачи |
POST /api/tasks/{taskId}/new-doc/{docType}
Добавить новый документ в задачу |
||
---|---|---|
Параметр |
Формат |
Описание |
taskId |
integer |
Номер задачи |
docType |
string |
Тип нового документа |
POST /api/tasks/{taskId}/responsible-performer/{userId}
Добавить подзадачу для задачи |
|||
---|---|---|---|
Параметр |
Формат |
Описание |
|
taskId |
integer |
Номер задачи |
|
subtaskId |
integer |
Идентификаторы категории подзадачи |
|
needCopySubscribers |
boolean |
Копировать подписчиков из родительской задачи |
|
needCopyFiles |
boolean |
Копировать вложения из родительской задачи |
|
deletePreviousParent |
boolean |
Удалить предыдущую родительскую задачу |
|
|
POST /api/tasks/{taskId}/add-task-link
Связать задачу с задачей |
|||
---|---|---|---|
Параметр |
Формат |
Описание |
|
taskId |
integer |
Номер задачи |
|
subtaskId |
integer |
Идентификаторы категории |
|
needCopySubscribers |
boolean |
Копировать подписчиков из родительской задачи |
|
needCopyFiles |
boolean |
Копировать вложения из родительской задачи |
|
isSilent |
boolean |
Тихий комментарий |
|
linkType |
string |
Возможные варианты: "None", "StartToStart", "StartToFinish", "FinishToStart", "FinishToFinish" |
|
|
Смена исполнителя задачи |
|||
---|---|---|---|
Параметр |
Формат |
Описание |
|
taskId |
integer |
Номер задачи |
|
newOwnerId |
integer |
Идентификатор нового исполнителя |
|
initiatorUserId |
integer |
Идентификатор пользователя-инициатора действия |
|
|
POST /api/tasks/{taskId}/changeState
Изменить статус задачи |
|||
---|---|---|---|
Параметр |
Формат |
Описание |
|
taskId |
integer |
Номер задачи |
|
newStateId |
integer |
Идентификатор нового статуса |
|
initiatorUserId |
integer |
Идентификатор пользователя-инициатора действия |
|
|
POST /app/v1.0/api/tasks/template
Получить шаблон для редактирования задачи |
|||
---|---|---|---|
Параметр |
Формат |
Описание |
|
subcatId |
integer |
Идентификатор подкатегории |
|
parentTaskId |
integer |
Идентификатор родительской задачи |
|
taskId |
integer |
Идентификатор задачи |
|
action |
string |
Действие с задачей. Возможные варианты: ['NewTask', 'CopyTask', 'MoveTask', 'NewLinkTask', 'NewSubtask'] |
|
|
Изменение запросом системных параметров задачи: текст задачи, заказчик, исполнитель, подписчики, срок. |
|||
---|---|---|---|
Параметр |
Формат |
Описание |
|
TaskText |
string |
Текст задачи |
|
dueDate |
datetime |
Срок |
|
Performers |
array |
Исполнители — массив объектов ( "userId":int, "isResponsiblePerformer":?bool) |
|
Owner |
int |
Заказчик |
|
Subscribers |
array |
Подписчики |
|
|
ДП Таблица
GET /app/v1.2/api/ep/tableSettings/{tableId}/subcat/{subcatId}/{taskId}
Получить настройки ДП Таблица: общие настройки и список столбцов |
|||||
---|---|---|---|---|---|
Параметр |
Формат |
Описание |
|||
tableId |
integer |
Идентификатор таблицы |
|||
subcatId |
integer |
Идентификатор категории |
|||
taskId |
integer |
Номер задачи |
|||
|
GET /app/v1.2/api/admin/extparams/table/{tableExtParamId}/columns/{columnId}
Получить указанный столбец таблицы. |
|||||
---|---|---|---|---|---|
Параметр |
Формат |
Описание |
|||
tableExtParamId |
integer |
Идентификатор таблицы |
|||
columnId |
integer |
Идентификатор столбца |
|||
|
POST /app/v1.2/api/task/{taskId}/ep/table/{tableId}/update
Обновление данных в ДП Таблица |
|||
---|---|---|---|
Параметр |
Формат |
Описание |
|
rows |
array |
Массив объектов |
|
id |
integer |
Идентификатор строки |
|
modifyType |
string |
Тип операции со строкой ['create', 'update', 'delete'] |
|
cols |
array |
Массив объектов с id колонки и значением |
|
|
POST /app/v1.2/api/admin/extparams/table/{tableExtParamId}/columns/add
Добавить указанный столбец таблицы |
|||||
---|---|---|---|---|---|
Параметр |
Формат |
Описание |
|||
tableExtParamId |
integer |
Идентификатор таблицы |
|||
columnSetting |
array |
Настройки столбца |
|||
|
POST /app/v1.2/api/admin/extparams/table/{tableExtParamId}/columns/edit
Редактировать указанный столбец таблицы |
|||||
---|---|---|---|---|---|
Параметр |
Формат |
Описание |
|||
tableExtParamId |
integer |
Идентификатор таблицы |
|||
columnId |
integer |
Идентификатор столбца |
|||
columnSetting |
array |
Настройки столбца |
|||
|
POST /app/v1.2/api/admin/extparams/table/{tableExtParamId}/columns/delete
Редактировать указанный столбец таблицы |
||
---|---|---|
Параметр |
Формат |
Описание |
tableExtParamId |
integer |
Идентификатор таблицы |
columnId |
integer |
Идентификатор столбца |
Избранное
Удалить папку из избранного |
||
---|---|---|
Параметр |
Формат |
Описание |
folderId |
integer |
Идентификатор папки |
Добавить ссылку в Избранное |
|||
---|---|---|---|
Параметр |
Формат |
Описание |
|
link |
string |
Ссылка |
|
name |
string |
Название |
|
isJsFunction |
boolean |
JS функция |
|
customImagePath |
string |
Путь к изображению |
|
customImageClass |
string |
Название класса изображения |
|
type |
string |
Тип ссылки. Варианты значений: ['None', 'Subcategory', 'Category', 'Task', 'SearchReport', 'NewTaskInSubcat', 'Report', 'User', 'Comment', 'MailFolder', 'SummaryCategory', 'SearchMailFolder', 'PortalGrid', 'PublicLink', 'SmartSearch'] |
|
linkedObjectId |
integer |
Идентификатор связанного объекта |
|
folderId |
integer |
Идентификатор папки избранного |
|
|
Добавить папку в Избранное |
|||
---|---|---|---|
Параметр |
Формат |
Описание |
|
name |
string |
Название папки |
|
parentId |
integer |
Идентификатор родительской папки |
|
|
Переместить ссылку в папку |
|||
---|---|---|---|
Параметр |
Формат |
Описание |
|
linkId |
integer |
Идентификатор ссылки |
|
folderId |
integer |
Идентификатор папки |
|
groupId |
integer |
Идентификатор группы |
|
|
Поделиться ссылкой |
|||
---|---|---|---|
Параметр |
Формат |
Описание |
|
linkId |
integer |
Идентификатор ссылки |
|
userIds |
array |
Список пользователей-получателей ссылки |
|
|
Переименовать ссылку |
|||
---|---|---|---|
Параметр |
Формат |
Описание |
|
linkId |
integer |
Идентификатор ссылки |
|
newName |
string |
Новое наименование ссылки |
|
|
POST /api/favorite/renameFolder
Переименовать папку |
|||
---|---|---|---|
Параметр |
Формат |
Описание |
|
linkId |
integer |
Идентификатор папки |
|
newName |
string |
Новое наименование папки |
|
|
Обновить иконку |
|||
---|---|---|---|
Параметр |
Формат |
Описание |
|
linkId |
integer |
Идентификатор ссылки |
|
customImageClass |
string |
Класс изображения |
|
|
Удалить ссылку из избранного |
||
---|---|---|
Параметр |
Формат |
Описание |
linkId |
integer |
Идентификатор ссылки |
Индикаторы
Получить все тикеры |
|||
---|---|---|---|
|
Получить кастомные тикеры |
|||
---|---|---|---|
|
Получить системные тикеры |
|||
---|---|---|---|
|
Получить имена системных тикеров |
|||
---|---|---|---|
|
История
Получить сотрудников (группа + сотрудники) |
|||||
---|---|---|---|---|---|
Параметр |
Формат |
Описание |
|||
count |
integer |
Количество |
|||
|
Получить сотрудников (группа + сотрудники) |
|||||
---|---|---|---|---|---|
Параметр |
Формат |
Описание |
|||
groupsCount |
integer |
Количество групп |
|||
coworkersCount |
integer |
Количество сотрудников |
|||
|
Календарь
Получить используемого провайдера по умолчанию |
|||
---|---|---|---|
Параметр |
Формат |
Описание |
|
providerName |
string |
Наименование провайдера |
|
enableRecurrence |
boolean |
Включить повторения |
|
|
Получить карточку встречи |
||
---|---|---|
Параметр |
Формат |
Описание |
key |
string |
Ключ встречи |
Получить вложения встречи |
||
---|---|---|
Параметр |
Формат |
Описание |
key |
string |
Ключ вложения. Его можно получить через get/update/create. |
GET /api/calendar/all-attachments
Получить все вложения встречи |
||
---|---|---|
Параметр |
Формат |
Описание |
key |
string |
Ключ встречи api/calendar/all-attachments?key={meetingKey} |
Проверка прав на почтовый ящик |
|||||
---|---|---|---|---|---|
Параметр |
Формат |
Описание |
|||
toUserId |
integer |
Идентификатор пользователя, права которого необходимо проверить.
/api/calendar/permissions?toUserId=123 |
|||
fromUserId |
integer |
Идентификатор пользователя, права к которому необходимо проверить. Позволяет осуществить проверку прав от одного пользователя к другому: /api/calendar/permissions?toUserId=123&fromUserId=456 |
|||
|
Поиск пользователей по email |
|||||
---|---|---|---|---|---|
Параметр |
Формат |
Описание |
|||
name |
string |
Email-адрес |
|||
contextMeetingKey |
string |
Ключ встречи |
|||
|
Список всех календарных событий за период |
|||||
---|---|---|---|---|---|
Параметр |
Формат |
Описание |
|||
from |
datetime |
Начало периода |
|||
to |
datetime |
Окончание периода |
|||
calendarOwnerUserId |
integer |
Календарь пользователя. По умолчанию сессионного. |
|||
taskId |
integer |
Идентификатор задачи |
|||
Значения freeBusyState: •"Free" ="Свободен" •"Busy" = "Занят" •"Tentative" = "Под вопросом" •"OOF" = "Нет на месте" •"WorkingElsewhere"= "Работаю в другом месте" |
GET /app/v1.2/api/calendar/nonworkingdays
Возвращает все нерабочие дни производственного календаря (как праздничные, так и выходные) в диапазоне "от" и "до" включительно. |
|||||
---|---|---|---|---|---|
Параметр |
Формат |
Описание |
|||
from |
datetime |
Дата начала |
|||
to |
datetime |
Дата окончания |
|||
|
GET /app/v1.2/api/calendar/menuItems
Возвращает элементы всплывающего меню календаря |
|||||
---|---|---|---|---|---|
Параметр |
Формат |
Описание |
|||
subcatId |
integer |
Идентификатор календарной категории |
|||
take |
integer |
Сколько занимают категории календаря (по умолчанию 20) |
|||
|
GET /app/v1.2/api/calendar/nonworkingdaysandpreholidays
Возвращает все нерабочие дни из производственного календаря (праздничные, выходные и предпраздничные дни) в диапазоне "от" и "до" включительно |
|||||
---|---|---|---|---|---|
Параметр |
Формат |
Описание |
|||
year |
integer |
Год |
|||
from |
datetime |
Дата начала |
|||
to |
datetime |
Дата окончания |
|||
|
Прочтение сообщения о календарном событии |
|||
---|---|---|---|
Параметр |
Формат |
Описание |
|
key |
string |
Ключ встречи |
|
action |
string |
Действие |
|
args |
object |
"args": { "additionalProp1": [ "string" ], "additionalProp2": [ "string" ], "additionalProp3": [ "string" ] } |
|
|
Прочтение списка календарных событий в диапазоне |
|||
---|---|---|---|
Параметр |
Формат |
Описание |
|
dateFrom |
string |
Начало диапазона |
|
dateTo |
string |
Окончание диапазона |
|
limit |
integer |
Размер страницы |
|
offset |
integer |
Количество пропускаемых элементов при генерации страницы |
|
meetingKey |
string |
Ключ встречи |
|
|
POST /api/calendar/messages/unread/count
Количество непрочитанных сообщений о календарных событиях в диапазоне |
|||
---|---|---|---|
Параметр |
Формат |
Описание |
|
dateFrom |
string |
Начало диапазона |
|
dateTo |
string |
Окончание диапазона |
|
|
Создать встречу |
|||
---|---|---|---|
Параметр |
Формат |
Описание |
|
calendarOwnerUserId |
string |
Календарь пользователя. По умолчанию сессионного. |
|
Значения freeBusyState: •"Free" ="Свободен" •"Busy" = "Занят" •"Tentative" = "Под вопросом" •"OOF" = "Нет на месте" •"WorkingElsewhere"= "Работаю в другом месте" |
POST /app/v1.2/api/calendar/isWorkingDateTime
Раздельная проверка времени на вхождение в допустимый рабочий инервал и проверка даты на пересечение с выходными и праздниками |
|||
---|---|---|---|
Параметр |
Формат |
Описание |
|
timestamp |
number |
Интервал времени |
|
performerId |
integer |
Идентификатор исполнителя |
|
|
Отображение календарных событий |
|||
---|---|---|---|
Параметр |
Формат |
Описание |
|
dateFrom |
string |
Начало периода |
|
dateTo |
string |
Конец периода |
|
limit |
integer |
Размер страницы |
|
offset |
integer |
Количество пропускаемых элементов при генерации страницы |
|
meetingKey |
string |
Ключ встречи |
|
|
Удаление встречи |
||
---|---|---|
Параметр |
Формат |
Описание |
key |
string |
Ключ встречи |
Внесение изменений в существующую встречу в календаре |
|||
---|---|---|---|
Параметр |
Формат |
Описание |
|
key |
string |
Ключ встречи |
|
Значения freeBusyState: •"Free" ="Свободен" •"Busy" = "Занят" •"Tentative" = "Под вопросом" •"OOF" = "Нет на месте" •"WorkingElsewhere"= "Работаю в другом месте" |
Комментарии
GET /app/v1.2/api/mobile/comments/{commentId}/likedby
Получение списка пользователей которые лайкнули комментарий |
||
---|---|---|
Параметр |
Формат |
Описание |
commentId |
integer |
Идентификатор комментария |
GET /api/comments/recipients/{commentId}/{searchInArchiveIfNotFound}
Получить получателей комментария |
||
---|---|---|
Параметр |
Формат |
Описание |
commentId |
integer |
Идентификатор комментария |
searchInArchiveIfNotFound |
boolean |
Искать в архиве, если получатели не найдены |
Отображать ленту комментариев |
|||
---|---|---|---|
Параметр |
Формат |
Описание |
|
limit |
integer |
Размер страницы |
|
offset |
integer |
Количество пропускаемых элементов при генерации страницы |
|
subcatId |
integer |
Уникальный идентификатор категории |
|
catId |
integer |
|
|
lentaCommTypes |
array |
Массив объектов |
|
commentId |
integer |
Идентификаор комментария, от которого отображается лента |
|
limitBefore |
integer |
Количество комментариев до указанного комментария в параметре Commentid |
|
limitAfter |
integer |
Количество комментариев после указанного комментария в параметре Commentid |
|
|
Оставить комментарий |
|||
---|---|---|---|
Параметр |
Формат |
Описание |
|
taskId |
integer |
Номер задачи, в которой необходимо отправить комментарий |
|
commentText |
string |
Текст комментария |
|
recipientIds |
array |
Список идентификаторов (ID) получателей комментария |
|
copyRecipientsIds |
array |
Список идентификаторов (ID) получателей копии комментария |
|
inReplyToCommentId |
integer |
Идентификатор комментария, в ответ на который написан текущий комментарий |
|
fileIds |
array |
Массив объектов |
|
isChat |
boolean |
Комментарий в чате |
|
needsAnswer |
boolean |
Пометить комментарий как вопрос |
|
guid |
string |
Comments.GUID |
|
|
Удалить комментарии |
|||
---|---|---|---|
Параметр |
Формат |
Описание |
|
ids |
array |
Массив идентификаторов комментариев, которые нужно удалить |
|
|
POST /api/comments/previous-task-comments
Отображать предыдущие комментарии в задаче |
|||
---|---|---|---|
Параметр |
Формат |
Описание |
|
taskId |
integer |
Номер задачи |
|
maxCommentId |
integer |
Идентификатор комментария |
|
maxCommentsToReturn |
integer |
Количество предыдущих комментариев для отображения |
|
|
POST /api/comments/mark-as-question/{commentId}
Отметить комментарий как вопрос |
||
---|---|---|
Параметр |
Формат |
Описание |
commentId |
integer |
Уникальный идентификатор комментария, которой необходимо отметить как вопрос |
POST /api/comments/mark-comments-as-read
Отметить комментарий как прочитанный |
||
---|---|---|
Параметр |
Формат |
Описание |
commentIds |
integer |
Уникальный идентификатор комментария, которой необходимо отметить прочитанным |
POST /api/comments/mark-as-not-my-question/{commentId}
Отметить комментарий как "Вопрос не мне" |
||
---|---|---|
Параметр |
Формат |
Описание |
commentId |
integer |
Уникальный идентификатор комментария, которой необходимо отметить как "Вопрос не мне" |
POST /api/comments/mark-as-answered
Отметить вопрос как отвеченный |
|||
---|---|---|---|
Параметр |
Формат |
Описание |
|
commentId |
integer |
Уникальный идентификатор пользователя |
|
commentText |
string |
Текст ответа на вопрос |
|
isForAll |
boolean |
Вопрос отвечен для всех |
|
|
POST /app/v1.2/api/mobile/comments/{commentId}/edit
Обновление текста комментария |
|||
---|---|---|---|
Параметр |
Формат |
Описание |
|
commentId |
integer |
Уникальный идентификатор пользователя |
|
text |
string |
Текст комментария |
|
|
POST /app/v1.2/api/mobile/comments/{commentId}/like
Поставить лайк комментарию |
|||
---|---|---|---|
Параметр |
Формат |
Описание |
|
commentId |
integer |
Уникальный идентификатор комментария |
|
likesCount |
integer |
Количество лайков |
|
isLikedByCurrentUser |
boolean |
Лайкт от текущего пользователя |
|
canBeLiked |
boolean |
Комментарий, которому можно поставить лайк |
|
|
POST /app/v1.2/api/mobile/comments/{commentId}/unlike
Убрать лайк с комментария |
|||
---|---|---|---|
Параметр |
Формат |
Описание |
|
commentId |
integer |
Уникальный идентификатор комментария |
|
likesCount |
integer |
Количество лайков |
|
isLikedByCurrentUser |
boolean |
Лайкт от текущего пользователя |
|
canBeLiked |
boolean |
Комментарий, которому можно поставить лайк |
|
|
Добавить комментарий в избранное |
|||
---|---|---|---|
Параметр |
Формат |
Описание |
|
commentId |
integer |
Идентификатор комментария, который необходимо добавить в избранное |
|
color |
string |
Цвет текста комментария после добавления в избранное |
|
|
Локализация
Получить все используемые языки |
|||
---|---|---|---|
|
Получить язык пользователя |
|||
---|---|---|---|
|
Получить системный язык по умолчанию |
|||
---|---|---|---|
|
МП
Отзыв подписей у задачи |
||
---|---|---|
Параметр |
Формат |
Описание |
taskId |
integer |
Уникальный идентификатор задачи |
includeToolbar |
boolean |
Отдавать панель инструментов задачи |
Закрепить задачу как чат |
||
---|---|---|
Параметр |
Формат |
Описание |
taskId |
integer |
Уникальный идентификатор задачи, которую нужно закрепить |
Открепить задачу от чата |
||
---|---|---|
Параметр |
Формат |
Описание |
taskId |
integer |
Уникальный идентификатор задачи, которую нужно открепить |
POST /api/mobile-app/settings/update
Обновить настройки мобильных приложений пользователя |
|||
---|---|---|---|
Параметр |
Формат |
Описание |
|
notifInCallOnWorkPhone |
boolean |
Уведомлять о вызове |
|
notifyUntilOpen |
boolean |
Уведомлять до открытия |
|
showUserAvatars |
boolean |
Показывать аватары пользователей |
|
twoStepsAuthenticatorNotificationType |
string |
Тип двухфакторной аутентификации. Примеры значений: ['None', 'Sms', 'Push'] |
|
|
POST /api/mobile-app/send-link-to-email
Отправлять ссылку на мобильное приложение на почту |
|||
---|---|---|---|
Параметр |
Формат |
Описание |
|
string |
Идентификатор комментария, который необходимо добавить в избранное |
||
appType |
string |
Тип приложеня. Примеры значений: ['OneFChat', 'AndroidOneFChat', 'OneFChat_AppStore_1f', 'DirectorsClub', 'DirectorsClub_AppStore_1f', 'iOSMobile_1', 'iOSMobile_1_AppStore', 'iOSMobile_2', 'iOSMobile_2_AppStore', 'iOSMobile_3', 'iOSMobile_3_AppStore', 'iOSMobile_4', 'iOSMobile_4_AppStore', 'iOSMobile_5', 'iOSMobile_5_AppStore', 'AnyClient'] |
|
|
Подписи
GET /api/signatures/dynamic/{signatureId}/acceptors
Возвращает акцептантов запроса динамической подписи |
||
---|---|---|
Параметр |
Формат |
Описание |
signatureId |
integer |
Динамическая подпись |
taskId |
integer |
Задача, в которой запрашивается подпись |
Возвращает динамические подписи с настройками |
||
---|---|---|
Параметр |
Формат |
Описание |
taskId |
integer |
Задача, в которой допустим запрос подписи (опционально). Если не указан — вернет все настроенные в системе динамические подписи |
acceptantId |
integer |
Допустимый акцептант подписи (опционально). Если указан — возвращаются только подписи, где пользователь может быть акцептантом |
GET /api/storage/signatures/{id}
Получает совокупность подписей по идентификатору |
||
---|---|---|
Параметр |
Формат |
Описание |
id |
integer |
Идентификатор подписи |
Получает совокупность подписей по диапазону |
||
---|---|---|
Параметр |
Формат |
Описание |
skip |
integer |
Пропустить в порядке хранения |
take |
integer |
Принять в порядок хранения |
POST /api/signatures/dynamic/request
Запросить динамическую подпись |
|||
---|---|---|---|
Параметр |
Формат |
Описание |
|
taskId |
integer |
Номер задачи |
|
due |
string |
Срок подписи |
|
reason |
string |
Причина запроса подписи |
|
acceptors |
array |
Список акцептантов |
|
signatureId |
integer |
Идентификатор подписи |
|
separateForEach |
boolean |
Отдельная подпись для каждого акцептанта |
|
|
Пользователи
Получить информацию о пользователе |
|||||
---|---|---|---|---|---|
Параметр |
Формат |
Описание |
|||
userId |
integer |
Уникальный идентификатор пользователя |
|||
|
Получить пользовательские настройки |
|||||
---|---|---|---|---|---|
Параметр |
Формат |
Описание |
|||
userId |
integer |
Уникальный идентификатор пользователя |
|||
|
Получить информацию о пользователе |
|||||
---|---|---|---|---|---|
Параметр |
Формат |
Описание |
|||
userId |
integer |
Уникальный идентификатор пользователя |
|||
includeUserEvents |
boolean |
Получить события пользователя |
|||
inlcudeCoWorkers |
boolean |
Получить информацию о коллегах |
|||
|