Tasks
Задачи в системе
| API | Description |
|---|---|
| GET api/Tasks?type={type}&page={page}&size={size}&sort={sort}&descending={descending}&status={status} |
Задачи в системе с учетом фильтра, сортировки с постраничным выводом |
| GET api/Tasks/{id} |
Задача с номером Id |
| GET api/Tasks/{id}/comments |
Комментарии для задачи с номером Id в древовидной форме |
| GET api/Tasks/{id}/SubRequests |
Список вложенных заявок |
| GET api/Tasks/{id}/SubTasks |
Список вложенных задач |
| GET api/Tasks/{id}/DependentTasks |
Список зависимых задач, в которые вложена задача |
| GET api/Tasks/{id}/SearchAvailableContractors?text={text} |
Осуществляет поиск сотрудников, которым можно делегировать задачу |
| POST api/Tasks/Filter |
Фильтрация задач с постраничным выводом и с учетом сортировки |
| POST api/Tasks/FilterCount |
Кол-во задач с учетом фильтра |
| POST api/Tasks/Search |
Поиск задач с постраничным выводом и с учетом сортировки |
| POST api/Tasks/SearchCount |
Кол-во задач с учетом строки поиска |
| POST api/Tasks |
Создание новой задачи |
| POST api/Tasks/v3/CreateMultipleTasks |
Создание списка(множества) новых задач |
| GET api/Tasks/{id}/Copy?mask={mask} |
Возвращает макет копии задачи |
| POST api/Tasks/{id}/Favourites |
Добавляет задачу с номером id в избранное |
| PUT api/Tasks/{id}/SubRequests/{requestId}?lastModifiedDate={lastModifiedDate} |
Добавляет заявку с номером requestId к задаче с номером Id |
| PUT api/Tasks/{id}/SubTasks/{subTaskId}?lastModifiedDate={lastModifiedDate} |
Добавляет вложенную задачу с номером subTaskId к задаче с номером Id |
| POST api/Tasks/{id}/Comments |
Добавляет комментарий к задаче с номером id |
| PUT api/Tasks/{id} |
Редактирование задачи с номером id |
| PUT api/Tasks/{id}/Observers |
Обозреватели.Частичное обновление задачи с номером id. |
| PUT api/Tasks/{id}/Approvers |
Согласующие. Частичное обновление задачи с номером id. |
| PUT api/Tasks/{id}/Attachments |
Частичное обновление задачи с номером id. Вложения. |
| PATCH api/Tasks/{id}/Attachments |
Добавляет вложения к задаче |
| PUT api/Tasks/{id}/Hashtags |
Частичное обновление заявки с номером id. Хэштеги. |
| PUT api/Tasks/{id}/Contractor |
Устанавливает исполнителя для задачи с номером id. |
| PUT api/Tasks/{id}/Initiator |
Частичное обновление заявки с номером id. Инициатор. |
| PUT api/Tasks/{id}/TodoList |
Частичное обновление задачи с номером id. Список дел. |
| PUT api/Tasks/{id}/Priority |
Частичное обновление задачи с номером id. Приоритет. |
| PUT api/Tasks/{id}/RequiredDate |
Частичное обновление задачи с номером id. Даты начала и окончания задачи. |
| PUT api/Tasks/{id}/Subject |
Редактирование темы задачи |
| PUT api/Tasks/{id}/Description |
Редактирование Описания задачи |
| PUT api/Tasks/{id}/Action |
Частичное обновление с номером id. Действия с задачей |
| PUT api/Tasks/{id}/ReadAll |
Прочитать все комментарии задачи, адресованные текущему пользователю |
| DELETE api/Tasks/{id}/Favourites |
Удаляет задачу с номером id из избранного |
| DELETE api/Tasks/{id}/SubRequests/{requestId}?lastModifiedDate={lastModifiedDate} |
Удаляет заявку с номером requestId из задачи с номером Id |
| DELETE api/Tasks/{id}/SubTasks/{subTaskId}?lastModifiedDate={lastModifiedDate} |
Удаляет вложенную задачу с номером subTaskId из задачи с номером Id |
Users
Пользователи системы
| API | Description |
|---|---|
| GET api/Users/{Id}/photo |
Возвращает фото пользователя по идентификатору |
| GET api/Users/photo |
Возвращает фото текущего пользователя |
| GET api/Users/{id} |
Профиль пользователя с идентификатором id |
| GET api/Users/profile?login={login} |
Профиль пользователя |
| GET api/Users/current |
Профиль текущего пользователя |
| GET api/Users/search?text={text}&kind={kind} |
Осуществляет поиск сотрудников |
| GET api/Users/ResponsibilityGroups |
Принадлежность текущего пользователя группам ответственности(не системным) |
| GET api/Users/Regions |
Список всех регионов |
| POST api/Users/photo |
Загрузить фото пользователя |
| POST api/Users/FunctioningCapacity |
Получить рабочую загруженность списка пользователей |
| PUT api/Users/current |
Редактировать профиль текущего пользователя |
| PUT api/Users |
Редактировать профиль пользователя по Id |
| POST api/Users/{id}/MoveActiveAgrimentsToUser/{target}?setAlternate={setAlternate} |
Передать активные согласования одного пользователя другому |
WorkNormative
Норматив (Путь, Тип-Вид)
Account
Учетная запись пользователя
| API | Description |
|---|---|
| POST api/Account/ChangePassword |
Смена пароля пользователя |
| POST api/Account/SetPassword |
Установка пароля пользователя, если он не был ранее установлен |
| POST api/Account/RegisterApi |
Регистрирует существующего пользователя СУ Гандива в API |
| POST api/Account/ConfirmRegistration |
Отправляет повторный запрос на подтверждение регистрации |
| POST api/Account/Restore |
Восстановление пароля |
| GET api/Account/ConfirmEmail?userId={userId}&token={token} |
Подтверждение регистрации пользователя |
| GET api/Account/ConfirmResetPassword?userId={userId}&token={token}&password={password} |
Подтверждение сброса пароля |
TimeSheet
Табель времени
| API | Description |
|---|---|
| GET api/TimeSheet/User?userId={userId}&date={date}&dateTo={dateTo} |
Вернуть табель пользователя за указанную дату или интервал дат |
| PUT api/TimeSheet/User |
Редактирование табеля пользователя за указанную дату или интервал дат |
Activity
Лента активности
| API | Description |
|---|---|
| GET api/Activity?page={page}&size={size} |
Лента активности непрочитанных комментариев пользователя с постраничным выводом элементов (заявок и задач) |
| GET api/Activity/Count |
Количество непрочитанных комментариев в ленте активности текущего пользователя (заявок и задач) |
| GET api/Activity/Requests/{id} |
Заявка - Элемент ленты активности текущего пользователя |
| GET api/Activity/Tasks/{id} |
Задача - Элемент ленты активности текущего пользователя |
KnowledgeBase
База знаний
| API | Description |
|---|---|
| GET api/KnowledgeBase/{id} |
Получить данные по ноде |
| GET api/KnowledgeBase/Nodes |
Вернуть все актуальные и те на которые есть разрешения ноды базы знаний |
| POST api/KnowledgeBase |
Создание ноды. Поддерживается в description создание картинки из base64 |
| DELETE api/KnowledgeBase/{id} |
Удалить ноду |
CustomFields
Элементы (дополнительные поля) микросправочников
| API | Description |
|---|---|
| POST api/CustomFields/SearchType |
Поиск типов микросправочника с постраничным выводом, с учетом сортировки и фильтрации |
| POST api/CustomFields/Search |
Поиск элементов микросправочника с постраничным выводом, с учетом сортировки и фильтрации |
| POST api/CustomFields |
Создать элемент микросправочника |
| POST api/CustomFields/Type |
Создать микросправочник |
| PUT api/CustomFields/{id} |
Редактирование элемента микросправочника с идентификатором id |
| POST api/CustomFields/{id}?isActual={isActual} |
Изменить актуальность элемента микросправочника с номером id |
ResponsibilityGroups
Группы ответственности (группы пользователей)
| API | Description |
|---|---|
| GET api/ResponsibilityGroups/{Id}/Users |
Возвращает состав группы ответственности по идентификатору группы ответственности |
AccessSheet
Листы допуска
| API | Description |
|---|---|
| GET api/AccessSheet/{id} |
Получение листа допуска |
| POST api/AccessSheet |
Создание листа допуска по выбранному списку ресрусов |
| POST api/AccessSheet/Search |
Получить список листов допуска с фильтрацией |
AccessTree
Ресурсы допуска
| API | Description |
|---|---|
| GET api/AccessTree/{id} |
Получить ресурс допуска |
| GET api/AccessTree/ChildrenNodes/{id} |
Поуровневое получение дерева ресурсов допуска |
| POST api/AccessTree |
Создание ресурса допуска |
| POST api/AccessTree/Search |
Поиск в ресурсах допуска |
| PUT api/AccessTree |
Редактирования ресурса допуска |
Requests
Заявки в системе
| API | Description |
|---|---|
| GET api/Requests?type={type}&page={page}&size={size}&sort={sort}&descending={descending}&status={status}&doNotSearchInArchive={doNotSearchInArchive} |
Заявки в системе с учетом фильтра, сортировки с постраничным выводом |
| GET api/Requests/{id}/LastModifiedDate |
Для указанного Id вернуть "Дату последних изменений" заявки |
| POST api/Requests/RequestsByIdList |
Заявки с комментариями по списку идентификаторов, доступно только модератору |
| GET api/Requests/{id} |
Заявка с номером Id |
| GET api/Requests/{id}/SubRequests |
Список вложенных заявок |
| GET api/Requests/{id}/DependentRequests |
Список зависимых заявок, в которые вложена заявка |
| GET api/Requests/{id}/DependentTasks |
Список зависимых задач, в которые вложена заявка |
| GET api/Requests/{id}/Dependencies |
[Ресурс устарел и будет удален. Используйте DependentRequests] |
| GET api/Requests/{id}/Comments |
Комментарии для заявки с номером Id в древовидной форме |
| GET api/Requests/UserFilters |
Сохраненные фильтры текущего пользователя |
| GET api/Requests/{id}/RequestResponsibilityGroupUsers |
[Ресурс устарел и будет удален. Используйте CurrentResponsibilityGroup] |
| GET api/Requests/{id}/CurrentResponsibilityGroup?withUsers={withUsers} |
Метод возвращает группу ответственности (с пользователями), к которой принадлежит данная заявка |
| GET api/Requests/{id}/GetContractorsList |
Возвращает список исполнителей для данной заявки |
| POST api/Requests/Filter |
Фильтрация заявок с постраничным выводом и с учетом сортировки |
| POST api/Requests/FilterCount |
Кол-во заявок с учетом фильтра |
| POST api/Requests/FilterByStatusOnPeriod |
Возвращает отфильтрованные по статусу на период времени заявки (метод доступен только модератору) |
| POST api/Requests/Search |
Поиск заявок с постраничным выводом и с учетом сортировки |
| POST api/Requests/SearchCount |
Кол-во заявок с учетом строки поиска |
| POST api/Requests |
Создание новой заявки |
| POST api/Requests/Recalculated |
Пересчитывает модель новой заявки, с учётом уже выборанного норматива |
| GET api/Requests/{id}/Copy?mask={mask} |
Возвращает макет копии заявки |
| POST api/Requests/{id}/Comments |
Добавляет комментарий к заявке с номером id |
| POST api/Requests/{id}/ClarificationQuestion |
Добавляет вопрос-уточнение в заявке с номером id |
| POST api/Requests/Comments/{id}/ClarificationAnswer |
Добавляет ответ на комментарий типа "уточнение-вопрос" |
| POST api/Requests/Comments/{id}/Join |
Присоединяет текущего пользователя к комментарию типа "уточнение-вопрос" |
| PUT api/Requests/Comments/{id}/Join |
Присоединяет текущего пользователя к комментарию типа "уточнение-вопрос" |
| POST api/Requests/Comments/{id}/CancelClarification |
Отменяет уточнение |
| POST api/Requests/{id}/Favourites |
Добавляет заявку с номером id в избранное |
| POST api/Requests/UserFilter |
Добавляет новый пользовательский фильтр |
| PUT api/Requests/{id} |
Редактирование заявки с номером id |
| PUT api/Requests/{id}/Observers |
Частичное обновление заявки с номером id. Обозреватели. |
| PUT api/Requests/v2/{id}/Approvers |
Частичное обновление заявки с номером id. Добавление согласующих. Если согласующий не принял решение и при обновлении он не был в списке согласующих - такой согласующий удаляется. |
| PUT api/Requests/{id}/Path |
Частичное изменение заявки, путь заявки (норматив + доп. поля + хэштеги). |
| PUT api/Requests/{id}/Contractor |
Частичное обновление заявки с номером id. Исполнитель. |
| PUT api/Requests/{id}/Initiator |
Частичное обновление заявки с номером id. Инициатор. |
| PUT api/Requests/{id}/Attachments |
Частичное обновление заявки с номером id. Вложения. |
| PATCH api/Requests/{id}/Attachments |
Добавляет вложения к заявке |
| PUT api/Requests/{id}/SubRequests/{subRequestId}?lastModifiedDate={lastModifiedDate} |
Добавить вложенную заявку с номером SubRequestId к заявке с номером Id |
| PUT api/Requests/{id}/Hashtags |
Частичное обновление заявки с номером id. Хэштеги. |
| PUT api/Requests/{id}/Region |
Частичное обновление заявки с номером id. Регион. |
| PUT api/Requests/{id}/Action |
Действия с заявкой, изменение её статуса. Также, какое решение принять согласующему: согласовать, отклонить или другое - делается этим методом. |
| PUT api/Requests/{id}/RequiredStartDate |
Частичное обновление задачи с номером id. Дата рассмотрения заявки. |
| PUT api/Requests/{id}/ReadAll |
Прочитать все комментарии, адресованные текущему пользователю, внутри для заявки |
| DELETE api/Requests/{id}/SubRequests/{subRequestId}?lastModifiedDate={lastModifiedDate} |
Удаляет вложенную заявку с номером SubRequestId из заявки с номером Id |
| DELETE api/Requests/{id}/Favourites |
Удаляет заявку с номером id из избранного |
Common
Общая информация
| API | Description |
|---|---|
| GET api/Common/HashTags/Search?text={text} |
Поиск хэштегов по названию |
| GET api/Common/Attachments/{guid} |
Возвращает вложение с уникальной меткой guid |
| GET api/Common/Attachments/{guid}/Info |
Возвращает вложение с уникальной меткой guid |
| GET api/Common/AttachmentsBase64/{guid} |
Возвращает Base64 вложение с уникальной меткой guid |
| GET api/Common/Favourites |
Возвращает список избранных элементов для данного пользователя |
| GET api/Common/Find?id={id} |
Находит заявки, задачи по Id |
| GET api/Common/Find?text={text} |
Поиск задач/заявок/проектов по номеру в строке или тексту. Если длинна text меньше 4-х и text содержит число, то поиск осуществляется только по номеру, иначе - по номеру и по тексту. |
| GET api/Common/ProcessCommentImages?src={src} |
Возвращает картинку по пути |
| POST api/Common/PushNotificationToken?token={token} |
No documentation available. |
| POST api/Common/SubscribeForNotifications |
Подписка на пуш уведомления |
| POST api/Common/UnsubscribeForNotifications |
Отмена подписки на пуш уведомления |
| GET api/Common/ping |
Проверка доступности сервера АПИ |
| POST api/Common/Attachments/Upload |
Сохраняет файлы во временное хранилище |
| POST api/Common/Attachments/UploadBase64 |
Сохраняет файлы в формате base64 во временное хранилище |
| PUT api/Common/Comments/{id}/Read |
Помечает комментарий как прочитанный |
| PUT api/Common/Comments/{id} |
Редактирование комментария |
| DELETE api/Common/Comments/{id} |
Удаление комментария |
Permissions
Разрешения на операции в системе
| API | Description |
|---|---|
| GET api/Permissions/Request/New |
Разрешения при создании заявки |
| GET api/Permissions/Request/Edit/{id} |
Разрешения при редактировании заявки |
| GET api/Permissions/Task/New |
Разрешения при создании задачи |
| GET api/Permissions/Task/Edit/{id} |
Разрешения при редактировании задачи |
Reports
Работа с отчётами
| API | Description |
|---|---|
| GET api/Reports |
Получение списка отчётов |
| POST api/Reports/{id}/download |
Сформировать указанный отчёт |
TaskUserFilters
Пользовательские фильтры в задачах
| API | Description |
|---|---|
| GET api/TaskUserFilters |
Получить все фильтры задач пользователя |
| POST api/TaskUserFilters |
Добавляет новый пользовательский фильтр |
| PUT api/TaskUserFilters/{id} |
Редактировать пользовательский фильтр |
| DELETE api/TaskUserFilters/{id} |
Удалить пользовательский фильтр |
| PUT api/TaskUserFilters/RenameName/{id}?name={name} |
Переименование пользовательского фильтра |