Внешние интеграции¶
Методы интеграции Системы через API приведены в таблице.
Методы интеграции Системы через API
| Назначение | Наименование сервиса | Формат обмена сообщениями | Тип запроса |
|---|---|---|---|
| ldm-digital-archive-service | |||
| Получить последнюю версию документа | <host>/api/v1/da/documents/{id}/versions/last |
REST | GET |
| Создать документ | <host>/api/v1/da/documents |
REST | POST |
| Создать задачу на проверку наличия и состояния архивных документов | <host>/api/v1/da/document-check-tasks |
REST | POST |
| Установить признак завершения срока хранения у документов, дел | <host>/api/v1/da/files/set-flag-expired |
REST | POST |
| Удалить доступ к документам по заявкам в архив с истекшим сроком | <host>/api/v1/da/requests/access-deny |
REST | POST |
| Обновить статус томов и дел после согласования сводной описи дел | <host>/api/v1/da/final-inventory-task/{id}/complete |
REST | PATCH |
| Создать композитный документ с вложениями и подписями | <host>/api/v1/da/documents/compound |
REST | POST |
| Получить список коллекций, в которые входит документ | <host>/api/v1/da/documents/{id}/collections |
REST | GET |
| Получить список документов для подборки | <host>/api/v1/da/collections/{id}/content-enrichment |
REST | GET |
| Удалить контент подборки и связанные бизнес-объекты | <host>/api/v1/da/collections/{id}/content-enrichment |
REST | DELETE |
| Создать бизнес-объект для хранения дополнительных атрибутов документа (как контента) | <host>/api/v1/da/documents/{id}/item |
REST | POST |
| Удалить бизнес-объект для хранения дополнительных атрибутов документа (как контента) | <host>/api/v1/da/documents/{id}/item |
REST | DELETE |
| Получить список томов дела для бумажных документов | <host>/api/v1/da/files/{id}/volumes/paper |
REST | GET |
| Получить список томов дела для экспертизы | <host>/api/v1/da/files/{id}/volumes |
REST | GET |
| Создать бизнес-объект для каждого члена комиссии в экспертизе ценности | <host>/api/v1/da/document-appraisal/{id}/items |
REST | POST |
| Зафиксировать итоговое решение по экспертизе ценности | <host>/api/v1/da/document-appraisal/{id}/final-result |
REST | POST |
| Уничтожить документы по акту | <host>/api/v1/da/destruction-act/{id}/dispose |
REST | POST |
| ldm-user-folders-service | |||
| Получить структуру папок для документа | <host>/api/v1/documents/{id}/folders-tree |
REST | GET |
| Получить ID корневой папки для документа | <host>/api/v1/documents/{id}/root-folder-id |
REST | GET |
| Создать связь документа и его корневой папки | <host>/api/v1/documents/{id}/root-folder-link |
REST | POST |
| Создать пользовательскую папку | <host>/api/v1/documents/{id}/folders |
REST | POST |
| Получить описание пользовательской папки | <host>/api/v1/documents/folders/{id} |
REST | GET |
| Обновить параметры папки | <host>/api/v1/documents/{id}/folders/{folderId} |
REST | PATCH |
| Получить количество документов в папке | <host>/api/v1/folders/{id}/documents/count |
REST | GET |
| Удалить папку по ее идентификатору с выбором действия содержимого папки | <host>/api/v1/folders/folders/{id} |
REST | DELETE |
| Добавить контент к папке | <host>/api/v1/folders/{id}/content |
REST | POST |
| Получить контент папки | <host>/api/v1/folders/{folderId}/content |
REST | GET |
| Удалить контент папки | <host>/api/v1/folders/{folderId}/content/{contentId} |
REST | DELETE |
| ldm-file-register-service | |||
| Создать раздел номенклатуры | <host>/api/v1/sections |
REST | POST |
| Изменить параметры раздела номенклатуры | <host>/api/v1/sections/{id} |
REST | PUT |
| Удалить раздел номенклатуры дел | <host>/api/v1/sections/{id} |
REST | DELETE |
| Получить список дел для раздела номенклатуры | <host>/api/v1/sections/{id}/files |
REST | GET |
| Создать новое дело | <host>/api/v1/files |
REST | POST |
| Изменить параметры дела | <host>/api/v1/files/{id} |
REST | PUT |
| Получить описание дела | <host>/api/v1/files/{id} |
REST | GET |
| Удалить дело | <host>/api/v1/files/{id} |
REST | DELETE |
| Получить описание тома дела | <host>/api/v1/files/volumes/{id} |
REST | GET |
| Изменить параметры тома дела | <host>/api/v1/files/volumes/{id} |
REST | PUT |
| Удалить том дела | <host>/api/v1/files/volumes/{id} |
REST | DELETE |
| Создать новый том дела | <host>/api/v1/files/{id}/volumes |
REST | POST |
| Получить список томов дела | <host>/api/v1/files/{id}/volumes |
REST | GET |
| Получить содержимое раздела справочника «Типовой перечень видов документов» | <host>/api/v1/document-types-sections/{id}/childs |
REST | GET |
| Удалить раздел типового перечня видов документов | <host>/api/v1/document-types-sections/{id} |
REST | DELETE |
| Копировать разделы и дела номенклатуры дел | <host>/api/v1/file-registers/copy |
REST | POST |
| ldm-long-term-archive-service | |||
| Создать задачу на обработку описи дел | <host>/api/v1/inventory-task |
REST | POST |
| Повторно запустить задачу на обработку описи дел | <host>/api/v1/inventory-task/{id}/initiate |
REST | PATCH |
| Обновить статусы документов и описей после приемки в архив | <host>/api/v1/inventory-task/{id}/complete |
REST | PATCH |
| ldm-converting-service | |||
| Конвертация файла | <host>/api/v1/convert |
REST | PUT |
Используемые в Системе API-методы описаны в документе «Описание REST API LDM.СSP. Digital Archive/ЛДМ.ПКС Цифровой архив».