В методах для работы с документами присутствует секция Signatures для получения информации об электронной подписи (ЭП). Секция Signatures содержит массив объектов подписей (вне зависимости от их статуса).
Доступная версия: V3:
- PUT /api/v3/documents — метод позволяет создать документ по идентификатору с возможностью загрузки файла:
- Совмещена работа методов Upload и BulkCreate — при передаче на вход файла (также как сейчас происходит для Upload) файл сразу отображается как документ в системе
- Место размещения выбирается в зависимости от передаваемого параметра (если возможно):
- Если пусто — в корень раздела Документы
- Если есть Id папки — в конкретную папку
- На выходе будут получены атрибуты вновь созданного документа с docID
- Можно загружать документы в дела и папки, к которым есть доступ у пользователя с правами на Редактирование и выше
- POST /api/v3/documents/CreateFromTemplate — метод позволяет создать документ по шаблону в указанную или корневую папку объекта:
- Передается Id шаблона
- Готовый документ добавляется в папку дела (Id папки или подпапки) — если не передан Id папки, то в корневую папку дела
- Если в шаблоне есть ссылки на отсутствующие теги в деле, то они игнорируются и документ создается (поведение аналогично методу FillTemplate из внутреннего API)
- Параметры на вход:
- Id шаблона документа
- Id дела, куда нужно положить документ
- Id папки или подпапки (если не задано, то в корень дела)
- Можно создавать документы по шаблону в делах, к которым есть доступ у пользователя с правами на Редактирование и выше.
- PUT /api/v3/documents/Update — метод позволяет обновить документ при наличии прав на Редактирование и выше — редактируемые системные атрибуты:
- Название (Name или Id) (обязательное):
- Если передали name и Id, name игнорируется
- Если передали неверный Id, отобразится ошибка
- Если передали только name, то используется name
- Тип (опциональное)
- Дата (обязательное)
- Папка (опциональное)
- Доп. атрибуты по тегам (без возможности изменения самого файла документа)
- Название (Name или Id) (обязательное):
- GET /api/v3/documents/{id} — метод позволяет получить атрибуты документа по идентификатору:
- Возвращает основные атрибуты документа (тип, дата и т.д.) и доп. атрибуты документа по тегам
- Можно получить документы, к которым есть доступ у пользователя на Просмотр и выше
- POST /api/v3/documents — метод позволяет получить список документов с фильтрацией по атрибутам:
- Фильтрация доступна по следующим атрибутам:
- Id родительской папки — если ни один параметр не указан, то отображается список от самой верхней директории раздела Документы
- Тип сущности (папка или файл) — по умолчанию отображаются обоих типов
- Типа документа (значение из справочника Тип документа)
- Id автора документа
- Дата создания документа
- Произвольная поисковая строка
- Папки исключаются из выборки при фильтрации по типу документа и/или дате создания
- Пользователь получает доступ к делам, к которым у него есть права на Просмотр или выше
- Фильтрация доступна по следующим атрибутам:
- GET /api/v3/documents/{id}/sign/{userId} — метод позволяет скачать отдельный файла подписи у подписанного документа:
- На вход передается Id файла, в который вложена подпись ЭП и Id пользователя, на выходе возвращается файл с подписью ЭП и именем
- Функционал на скачивание архива документа с ЭП сохраняется
- GET /api/v3/documents/Download — метод позволяет скачать файл документа с сервера по идентификатору:
- Аналог Download но вместо fileID передается docID
- Можно скачивать документы в делах, к которым у пользователя есть доступ на Чтение и выше
- GET /api/v3/documents/DownloadAsPdf — метод позволяет скачать файл документа в формате PDF для печати (с наложенной подписью), файл можно сохранить на инстанс методом Upload или отправить по почте методом в скриптах.
- DELETE /api/v3/documents — метод позволяет удалить документ по идентификатору (при наличии прав на Изменение).