Show/Hide Toolbars

Руководство администратора

Описание методов в swagger

 Ссылки Назад Вверх Вперед

Для работы с объектами используются следующие методы:

•GET — для получения данных.

•POST — для добавления данных.

•PUT — для изменения данных.

•DELETE — для удаления данных.

warning_icon  API веб-сервиса "Первой Формы" можно посмотреть, добавив в браузере к адресу вашего приложения "Первая Форма" строку /swagger:
https://<your_1forma>/swagger

Порядок действий:

1.Найдите нужный объект в общем списке объектов.

2.Найдите нужный метод объекта.

3.Заполните параметры метода, если они есть. Если для параметра есть схема, то по щелчку на поле со схемой она будет скопирована в поле со значением параметра. В эту схему подставьте правильные значения (см. пример ниже).

ws_api_1

Порядок работы с методом объекта (1-ая часть).

hmtoggle_arrow0Пример заполнения параметра для создания задачи

4.Когда все параметры заполнены, нажмите на кнопку "Try it out!".

5.Ниже будет сформирован адрес (URL) для вызова метода, а также отобразятся результаты вызова сервиса (например, номер созданной задачи и пр.), чтобы вы могли убедиться в правильности ваших настроек или проанализировать ошибки. В поле Response Code значение 200 означает корректное выполнение вызова, а 500 — ошибку.

ws_api_2

Порядок работы с методом объекта (2-ая часть).

warning_icon  Методы класса CommentsAdmin могут вызывать только пользователи, входящие в системную группу Administrators.

Наиболее используемые API методы

Agenda (Повестка дня)

hmtoggle_arrow0 POST /api/agenda

Email

hmtoggle_arrow0 GET /api/emails/{emailId}

hmtoggle_arrow0 POST /api/emails/delete

Аутентификация

hmtoggle_arrow0 GET /api/auth/info

hmtoggle_arrow0 POST /api/auth/{userId}/impersonate

hmtoggle_arrow0 POST /api/auth/{userId}/stopimpersonate

hmtoggle_arrow0 POST /api/auth/token/refresh

 

Группы

hmtoggle_arrow0 GET /api/group/group-card

Задачи

 

hmtoggle_arrow0 GET /app/v1.0/api/subcategories/tree

hmtoggle_arrow0 GET /api/tasks

hmtoggle_arrow0 GET /api/tasks/{taskId}/actions

hmtoggle_arrow0 GET /app/v1.0/api/tasks/{taskId}/mainroute

hmtoggle_arrow0 GET /api/tasks/check-exist-and-access/{taskId}

hmtoggle_arrow0 GET /api/tasks/{taskId}/states

hmtoggle_arrow0 GET /api/task/avatar/{taskId}

hmtoggle_arrow0 GET /api/tasks/linked/{taskId}

hmtoggle_arrow0 GET /api/tasks/subtasks/removelink/{taskId}/{subtaskId}

hmtoggle_arrow0 POST /app/v1.2/api/tasks/feeds

hmtoggle_arrow0 POST /api/tasks/feedsBySP

hmtoggle_arrow0 POST /api/tasks

hmtoggle_arrow0 POST /api/tasks/create

hmtoggle_arrow0 POST /api/tasks/set-color

hmtoggle_arrow0 POST /api/tasks/delete

hmtoggle_arrow0 POST /api/tasks/{taskId}/set-priority

hmtoggle_arrow0 POST /api/tasks/{taskId}/lock-due-date

hmtoggle_arrow0 POST /api/tasks/{taskId}/unlock-due-date

hmtoggle_arrow0 POST /api/tasks/{taskId}/change-duedate

hmtoggle_arrow0 POST /api/tasks/{taskId}/change-subscribers

hmtoggle_arrow0 POST /api/tasks/{taskId}/remove-all-subscribers

hmtoggle_arrow0 POST /api/tasks/{taskId}/change-performers

hmtoggle_arrow0 POST /api/tasks/{taskId}/responsible-performer/{userId}

hmtoggle_arrow0 POST /api/tasks/{taskId}/pin-as-chat-to-all-users

hmtoggle_arrow0 POST /api/tasks/{taskId}/new-doc/{docType}

hmtoggle_arrow0 POST /api/tasks/{taskId}/responsible-performer/{userId}

hmtoggle_arrow0 POST /api/tasks/{taskId}/add-task-link

hmtoggle_arrow0 POST /api/tasks/change-owner

hmtoggle_arrow0 POST /api/tasks/{taskId}/changeState

hmtoggle_arrow0 POST /app/v1.0/api/tasks/template

hmtoggle_arrow0 POST /api/tasks/params/update

ДП Таблица

hmtoggle_arrow0   GET /app/v1.2/api/ep/tableSettings/{tableId}/subcat/{subcatId}/{taskId}

hmtoggle_arrow0   GET /app/v1.2/api/admin/extparams/table/{tableExtParamId}/columns/{columnId}

hmtoggle_arrow0   POST /app/v1.2/api/task/{taskId}/ep/table/{tableId}/update

hmtoggle_arrow0   POST /app/v1.2/api/admin/extparams/table/{tableExtParamId}/columns/add

hmtoggle_arrow0   POST /app/v1.2/api/admin/extparams/table/{tableExtParamId}/columns/edit

hmtoggle_arrow0   POST /app/v1.2/api/admin/extparams/table/{tableExtParamId}/columns/delete

Избранное

hmtoggle_arrow0   GET /api/history/tasks

hmtoggle_arrow0   POST /api/favorite/addLink

hmtoggle_arrow0   POST /api/favorite/addFolder

hmtoggle_arrow0   POST /api/favorite/moveLink

hmtoggle_arrow0   POST /api/favorite/shareLink

hmtoggle_arrow0   POST /api/favorite/renameLink

hmtoggle_arrow0   POST /api/favorite/renameFolder

hmtoggle_arrow0   POST /api/favorite/updateIcon

hmtoggle_arrow0   POST /api/favorite/deleteLink

Индикаторы

hmtoggle_arrow0   GET /api/tickers/all

hmtoggle_arrow0   GET /api/tickers/custom

hmtoggle_arrow0   GET /api/tickers/system

hmtoggle_arrow0   GET /api/tickers/systemNames

История

hmtoggle_arrow0   GET /api/history/tasks

hmtoggle_arrow0   GET /api/history/employees

Календарь

hmtoggle_arrow0   GET /api/calendar/userConfig

hmtoggle_arrow0   GET /api/calendar/get

hmtoggle_arrow0   GET /api/calendar/attachment

hmtoggle_arrow0   GET /api/calendar/all-attachments

hmtoggle_arrow0   GET /api/calendar/permissions

hmtoggle_arrow0   GET /api/calendar/resolveName

hmtoggle_arrow0   GET /api/calendar/events

hmtoggle_arrow0   GET /app/v1.2/api/calendar/nonworkingdays

hmtoggle_arrow0   GET /app/v1.2/api/calendar/menuItems

hmtoggle_arrow0   GET /app/v1.2/api/calendar/nonworkingdaysandpreholidays

hmtoggle_arrow0   POST /api/calendar/action

hmtoggle_arrow0   POST /api/calendar/messages

hmtoggle_arrow0   POST /api/calendar/messages/unread/count

hmtoggle_arrow0   POST /api/calendar/create

hmtoggle_arrow0   POST /app/v1.2/api/calendar/isWorkingDateTime

hmtoggle_arrow0   POST /api/calendar/messages

hmtoggle_arrow0   DELETE /api/calendar/delete

hmtoggle_arrow0   PUT /api/calendar/update

Комментарии

hmtoggle_arrow0   GET /app/v1.2/api/mobile/comments/{commentId}/likedby

hmtoggle_arrow0   GET /api/comments/recipients/{commentId}/{searchInArchiveIfNotFound}

hmtoggle_arrow0   POST /api/comments/lenta

hmtoggle_arrow0   POST /api/comments/add

hmtoggle_arrow0   POST /api/comments/delete

hmtoggle_arrow0   POST /api/comments/previous-task-comments

hmtoggle_arrow0   POST /api/comments/mark-as-question/{commentId}

hmtoggle_arrow0   POST /api/comments/mark-comments-as-read

hmtoggle_arrow0   POST /api/comments/mark-as-not-my-question/{commentId}

hmtoggle_arrow0   POST /api/comments/mark-as-answered

hmtoggle_arrow0   POST /app/v1.2/api/mobile/comments/{commentId}/edit

hmtoggle_arrow0   POST /app/v1.2/api/mobile/comments/{commentId}/like

hmtoggle_arrow0   POST /app/v1.2/api/mobile/comments/{commentId}/unlike

hmtoggle_arrow0   POST /api/tasks/set-color

Локализация

hmtoggle_arrow0   GET /api/languages

hmtoggle_arrow0   GET /api/languages/user

hmtoggle_arrow0   GET /api/languages/default

МП

hmtoggle_arrow0   POST /api/mobile-app/settings/update

hmtoggle_arrow0   POST /api/mobile-app/send-link-to-email

Подписи

hmtoggle_arrow0 GET /api/signatures/dynamic/{signatureId}/acceptors

hmtoggle_arrow0 GET /api/signatures/dynamic

hmtoggle_arrow0 GET /api/storage/signatures/{id}

hmtoggle_arrow0 GET /api/storage/signatures

hmtoggle_arrow0 POST /api/signatures/dynamic/request

Пользователи

hmtoggle_arrow0   GET /api/user/{userId}/info

hmtoggle_arrow0   GET /api/user/settings

hmtoggle_arrow0   GET /api/user/{userId}/info