Show/Hide Toolbars

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

Примеры веб-сервисов Valhalla

Пример (PowerShell): связывание задач при win-аутентификации

Пример (C#): получение чатов для пользователя при forms-аутентификации

 

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

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

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

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

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

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

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

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

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

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

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

ws_api_1

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

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

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

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

ws_api_2

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

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

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

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

Устаревшее

POST /api/agenda

Email

GET /api/emails/{emailId}

POST /api/emails/delete

Администрирование

GET /api/admin/forms/tree

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

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

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

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

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

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

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

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

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

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

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

POST /api/admin/smart/packs/list

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

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

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

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

POST /api/admin/smartexpressions/list

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

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

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

POST /api/admin/subcategories

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

GET /api/admin/categories

POST /api/admin/categories

POST /api/admin/categories/{categoryId}

DELETE /api/admin/categories/{categoryId}

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

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

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

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

GET /api/admin/enums

GET /api/admin/enums/{type}

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

GET /api/admin/subcategories/steps

POST /api/admin/subcategories/steps

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

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

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

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

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

GET /api/admin/subcat/step/signatures

POST /api/admin/subcat/step/signatures

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

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

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

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

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

GET /api/subcategories/{subcatId}/notifications

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

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

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

GET /api/admin/subcat/extparam

POST /api/admin/subcat/extparams

POST /api/extparams/update

GET /api/admin/subcat/extparam

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

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

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

POST /api/portals/block/add

GET /api/portals/block/{blockId}

GET /api/portals/block/sections

GET /api/portals/block/types

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

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

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

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

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

GET /api/auth/info

POST /api/auth/{userId}/impersonate

POST /api/auth/{userId}/stopimpersonate

POST /api/auth/token/refresh

Брендирование

POST /api/admin/spa/branding

Группы

GET /api/group/group-card

Задачи

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

GET /api/tasks

GET /api/tasks/{taskId}/actions

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

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

GET /api/tasks/{taskId}/states

GET /api/task/avatar/{taskId}

GET /api/tasks/linked/{taskId}

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

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