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/admin/forms/tree

hmtoggle_arrow0 GET /api/admin/smart/packs-on-events/list/{subcatId}/{state}

Смарт события

hmtoggle_arrow0 GET /api/admin/smart/packs-on-events/list/{subcatId}

hmtoggle_arrow0 POST /api/admin/smart/packs-on-events/create

hmtoggle_arrow0 POST /api/admin/smart/packs-on-events/events-with-values/list

Смарт-расписания

hmtoggle_arrow0 POST /api/admin/smart/recurrences/execute/{id}

hmtoggle_arrow0 DELETE /api/admin/smart/recurrences/delete/{id}

hmtoggle_arrow0 POST /api/admin/smart/recurrences/delete/{id}

Пакеты действий

hmtoggle_arrow0 GET /api/admin/smart/packs/list/{subcatId}

hmtoggle_arrow0 POST /api/admin/smart/packs/list

hmtoggle_arrow0 DELETE /api/admin/smart/packs/delete/{packId}

hmtoggle_arrow0 POST /api/admin/smart/packs/delete/{packId}

Смарт-выражения

hmtoggle_arrow0 GET /api/admin/smartexpressions/list/{subcatId}

hmtoggle_arrow0 POST /api/admin/smartexpressions/list

hmtoggle_arrow0 POST /api/admin/smartexpressions/delete/{id}

hmtoggle_arrow0 DELETE /api/admin/smartexpressions/delete/{id}

Категории и разделы

hmtoggle_arrow0 POST /api/admin/subcategories

hmtoggle_arrow0 POST /api/admin/subcategories/{subcatId}/copy

hmtoggle_arrow0 GET /api/admin/categories

hmtoggle_arrow0 POST /api/admin/categories

hmtoggle_arrow0 POST /api/admin/categories/{categoryId}

hmtoggle_arrow0 DELETE /api/admin/categories/{categoryId}

hmtoggle_arrow0 POST /api/admin/categories/{categoryId}/copy

hmtoggle_arrow0 POST /api/admin/categories/{categoryId}/notifications/set

hmtoggle_arrow0 POST /api/admin/categories/{categoryId}/notifications/unset

hmtoggle_arrow0 POST /api/admin/categories/{categoryId}/permissions/revoke

hmtoggle_arrow0 GET /api/admin/enums

hmtoggle_arrow0 GET /api/admin/enums/{type}

Маршрут категории

hmtoggle_arrow0 GET /api/admin/subcategories/steps

hmtoggle_arrow0 POST /api/admin/subcategories/steps

hmtoggle_arrow0 POST /api/admin/subcategories/steps/restore/{subcatId}

hmtoggle_arrow0 GET /api/admin/subcategories/steps/{stepId}

hmtoggle_arrow0 POST /api/admin/subcategories/steps/{stepId}

hmtoggle_arrow0 DELETE /api/admin/subcategories/steps/{stepId}

hmtoggle_arrow0 POST /api/admin/subcategories/steps/copy/{stepId}

hmtoggle_arrow0 GET /api/admin/subcat/step/signatures

hmtoggle_arrow0 POST /api/admin/subcat/step/signatures

hmtoggle_arrow0 GET /api/admin/subcat/step/signatures/step/{stepId}/id/{stepSignatureId}

hmtoggle_arrow0 POST /api/admin/subcat/step/signatures/{stepSignatureId}

hmtoggle_arrow0 DELETE /api/admin/subcat/step/signatures/{stepSignatureId}

Уведомления в категории

hmtoggle_arrow0 POST /api/subcategories/{subcatId}/notifications/add

hmtoggle_arrow0 GET /api/subcategories/{subcatId}/notifications

hmtoggle_arrow0 POST /api/subcategories/{subcatId}/notifications/update

hmtoggle_arrow0 DELETE /api/subcategories/{subcatId}/notifications/delete

ДП в категории

hmtoggle_arrow0 GET /api/admin/subcat/extparam

hmtoggle_arrow0 POST /api/admin/subcat/extparams

hmtoggle_arrow0 GET /api/admin/subcat/extparam

hmtoggle_arrow0 DELETE /api/admin/subcat/extparams/subcat/{subcatId}/extparam/{extParamId}

hmtoggle_arrow0 POST /api/admin/subcat/extparams/{subcatId}

Настройки портального блока

hmtoggle_arrow0 POST /api/portals/block/add

hmtoggle_arrow0 GET /api/portals/block/{blockId}

hmtoggle_arrow0 GET /api/portals/block/sections

hmtoggle_arrow0 GET /api/portals/block/types

hmtoggle_arrow0 POST /api/portals/block/{blockId}/update

hmtoggle_arrow0 DELETE /api/portals/block/{blockId}/delete

hmtoggle_arrow0 GET /api/portals/block/{blockId}/type-params

hmtoggle_arrow0 POST /api/portals/block/{blockId}/type-params/update

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

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