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

Группы

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

POST /api/tasks/feedsBySP

POST /api/tasks

POST /api/tasks/create

POST /api/tasks/set-color

POST /api/tasks/delete

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

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

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

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

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

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

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

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

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

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

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

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

POST /api/tasks/change-owner

POST /api/tasks/{taskId}/changeState

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

POST /api/tasks/params/update

POST /api/task/actions/batch/smartbutton/smartbuttons

POST /api/task/files/history

POST /api/task/actions/batch/copy

ДП Таблица

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

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

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

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

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

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

Избранное

GET /api/history/tasks

POST /api/favorite/addLink

POST /api/favorite/addFolder

POST /api/favorite/moveLink

POST /api/favorite/shareLink

POST /api/favorite/renameLink

POST /api/favorite/renameFolder

POST /api/favorite/updateIcon

POST /api/favorite/deleteLink

Индикаторы

GET /api/tickers/all

GET /api/tickers/custom

GET /api/tickers/system

GET /api/tickers/systemNames

История

GET /api/history/tasks

GET /api/history/employees

Календарь

GET /api/calendar/userConfig

GET /api/calendar/get

GET /api/calendar/attachment

GET /api/calendar/all-attachments

GET /api/calendar/permissions

GET /api/calendar/resolveName

GET /api/calendar/events

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

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

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

POST /api/calendar/action

POST /api/calendar/messages

POST /api/calendar/messages/unread/count

POST /api/calendar/create

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

POST /api/calendar/messages

DELETE /api/calendar/delete

PUT /api/calendar/update

Комментарии

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

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

POST /api/comments/lenta

POST /api/comments/add

POST /api/comments/delete

POST /api/comments/previous-task-comments

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

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

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

POST /api/comments/mark-as-answered

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

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

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

POST /api/tasks/set-color

Локализация

GET /api/languages

GET /api/languages/user

GET /api/languages/default

МП

GET /app/v1.2/api/mobile/tasks/{taskId}

POST /app/v1.2/api/mobile/tasks/{taskId}/pin

POST /app/v1.2/api/mobile/tasks/{taskId}/unpin

POST /api/mobile-app/settings/update

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

Орг.структура

GET /api/org-structure/card

Подписи

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

GET /api/signatures/dynamic

GET /api/storage/signatures/{id}

GET /api/storage/signatures

POST /api/signatures/dynamic/request

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

GET /api/user/{userId}/info

GET /api/user/settings

GET /api/user/{userId}/info

GET /api/user/process-assistants/{userId}

GET /api/user/assistants/restrictions/{assistanceId}

POST /api/user/change-password

POST /api/user/password-recovery

POST /api/user/{userId}/language

POST /api/user/coworkers

POST /api/user/change-password

POST /api/admin/user/notifications/{userId}/subcategory-flag

POST /api/user/search

POST /api/user/{userId}/ui-settings

POST /api/user/short-info

POST /api/users/status

POST /api/user/process-assistants/add

POST /api/user/process-assistants/remove

POST /api/user/assistants/add

POST /api/user/assistants/restrictions/add

POST /api/user/assistants/restrictions/remove/{assistanceId}

Портал

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

Права групп на группы, категории, разделы

GET /api/admin/permissions/{entityType}/{entityId}/actions

GET /api/admin/permissions/{entityType}/{entityId}

POST /api/admin/permissions/{entityType}/{entityId}/set

Срок задачи

GET /app/v1.2/api/tasks/{taskId}/duadate

GET /app/v1.2/api/tasks/{taskId}/duedate/history

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

Трудозатраты

POST /api/resource-facts

POST /api/resource-facts/approve

POST /api/resource-facts/unapprove

Файлы

GET /app/v1.2/api/filestorage/file/{fileId}/version

GET /app/v1.2/api/filestorage/file/{fileId}/info

GET /app/v1.2/api/filestorage/file/{fileId}/neighbours

GET /api/files/thumbnails/{fileId}/{versionId}

POST /api/files/import/exceltodb

POST /api/files/preupload/base64

POST /api/files/upload/{uploadType}

POST /api/task/files

POST /app/v1.2/api/files/delete/{fileId}/task/{taskId}/{forced}/{silent}

POST /api/task/files/pin/{taskId}/{fileId}

POST /api/task/files/unpin/{taskId}/{fileId}

Чаты

GET /api/chats

POST /app/v1.2/api/chats/{chatId}/setNotificationMode/{notificationMode}

POST /api/chats

POST /api/chats/left/{taskId}

POST /api/chats/close/{taskId}