Блокировка документа через REST API

Последние изменение: 05.04.2019

Для редактирования коллективного документа через API нужно его заблокировать.


Блокировка методом block

Для этого нужно использовать метод block с идентификатором документа

http://localhost:12471/MobileSMARTS/api/v1/Docs('6007dccb-43c9-40f9-86ff-f66e413b0e77')/Block

В параметрах нужно обязательно указывать таймаут (через какое время документ автоматически разблокируется, если его не разблокировали вручную). Диапазон от 500 до 10000 мс.

Разблокировка методом unblock

Для ручной разблокировки нужно использовать метод unblock с указанием идентификатора документа. После ручной разблокировки - автоматическая разблокировка не произойдет.

http://localhost:12471/MobileSMARTS/api/v1/Docs('6007dccb-43c9-40f9-86ff-f66e413b0e77')/Unblock

Добавления новой строки методом post

Для добавления новой отдельной строки документа можно использовать метод post в DeclaredItems.

Пример

Редактирование методом patch

Для редактирования существующей строки можно пользоваться методом patch.

Пример

http://localhost:12471/MobileSMARTS/api/v1/Docs('6007dccb-43c9-40f9-86ff-f66e413b0e77')/DeclaredItems

При патче можно указывать только те поля, которые необходимо обновить в нужной строке. В теле обязательно нужно указывать uid нужной строки!

Удаление строки методом Delete

Для удаления нужной строки у документа можно использовать метод Delete.

Пример

DELETE http://localhost:12471/MobileSMARTS/api/v1/Docs('6007dccb-43c9-40f9-86ff-f66e413b0e77')/DeclaredItems('047df020-9b57-4814-80b0-f35104d8f359'),

тут в урле необходимо указать как идентификатор документа, так и uid строки из declaredItems.