Руководство разработчика и описание REST API ЛДМ. Управление документами (ЛДМ. УД)¶

Содержание¶

• Термины и сокращения
  • Термины
  • Сокращения
• Общая информация
  • Назначение Системы
  • Используемые инструменты разработки
• Создание нового микросервиса
  • Создание нового микросервиса (backend)
  • Создание нового микросервиса (frontend)
• Функции, выполняемые Системой
  • Аутентификация
    • Аутентификация по логину/паролю
    • Аутентификация через refresh token
  • Сервис dh-datamodel-service
    • Метод «Получить набор атрибутов»
    • Метод «Обновить набор атрибутов»
    • Метод «Удалить набор атрибутов»
    • Метод «Получить атрибут»
    • Метод «Создать атрибут»
    • Метод «Изменить атрибут»
    • Метод «Удалить атрибут из набора»
    • Метод «Получить список наборов атрибутов»
    • Метод «Создать набор атрибутов»
    • Метод «Получить список атрибутов»
    • Метод «Найти вхождения набора атрибутов в классы»
    • Метод «Получить регулярное выражение»
    • Метод «Изменить регулярное выражение»
    • Метод «Удалить регулярное выражение»
    • Метод «Получить список регулярных выражений»
    • Метод «Создать регулярное выражение»
    • Метод «Получить класс объекта по идентификатору»
    • Метод «Удаление класса из модели»
    • Метод «Получить список классов объектов»
    • Метод «Создание нового класса»
    • Метод «Обновление класса модели»
    • Метод «Удалить набор атрибутов из класса объекта»
    • Метод «Добавить набор атрибутов в класс объектов»
    • Метод «Изменить порядок наборов атрибутов для класса объекта»
    • Метод «Получить результаты анализа модели данных»
  • Сервис dh-documents-service
    • Метод «Создать документ»
    • Метод «Получить актуальный документ»
    • Метод «Удалить документ»
    • Метод «Создать рабочую копию документа»
    • Метод «Блокировать выбранную версию документа от удаления»
    • Метод «Разблокировать версию документа от удаления»
    • Метод «Перезаписать версию документа»
    • Метод «Удалить версию документа»
    • Метод «Резервирование документа»
    • Метод «Публикация рабочей версии документа»
    • Метод «Отмена резервирования и удаление рабочей копии»
    • Метод «Получить список версий документа»
    • Метод «Создать версию документа»
    • Метод «Получить версию документа»
    • Метод «Получить список документов (текущие версии или рабочие копии)»
    • Метод «Сформировать архив документов»
    • Метод «Запретить изменение пользовательских свойств выбранной версии документа»
    • Метод «Снять запрет на изменение пользовательских свойств выбранной версии документа»
    • Метод «Удалить контент документа»
    • Метод «Получить бизнес-объект по id»
    • Метод «Изменить бизнес-объект»
    • Метод «Удалить бизнес-объект»
    • Метод «Восстановить бизнес-объект из корзины»
    • Метод «Получить список бизнес-объектов в корзине»
    • Метод «Удалить бизнес-объект из корзины»
    • Метод «Получить список бизнес-объектов по заданным в запросе параметрам»
    • Метод «Создать бизнес-объект»
    • Метод «Включить версию простого документа в состав версии композитного документа»
    • Метод «Получить вложенные документы в версию композитного документа»
    • Метод «Исключить версии документов из версии композитного документа»
    • Метод «Получить предпросмотр контента для документа»
    • Метод «Скачать файл документа»
    • Метод «Получить список документов в корзине»
    • Метод «Восстановить документ из корзины»
    • Метод «Удалить документ из корзины»
    • Метод «Получить список версий документов, вложенных в версию композитного документа»
    • Метод «Добавить документы в пакет архивации»
    • Метод «Создать альтернативное представление документа вместе с контентом»
    • Метод «Создать альтернативное представление документа с ранее созданным файлом»
    • Метод «Поиск альтернативных представлений документа по атрибутам»
    • Метод «Получить информацию по альтернативному представлению документа»
    • Метод «Получить контент альтернативного представления документа»
    • Метод «Получить предпросмотр контента для альтернативного представления документа»
    • Метод «Получить список альтернативных представлений документа»
    • Метод «Удалить альтернативное представление документа»
    • Метод «Клонировать файл документа»
    • Метод «Получить конфигурацию контента документа для редактирования в Р7»
    • Метод «Проверить комплектность композитного документа»
    • Метод «Атрибутивный поиск по модели данных»
    • Метод «Проверить наличие доступа у пользователя к объекту для выполнения действия»
    • Метод «Получить токен для доступа к связанным объектам в других сервисах»
    • Метод «Проверить наличие доступа у пользователя к списку объектов для выполнения действий»
    • Метод «Получение требований к прикреплению файла к классу документа
    • Метод «Проверка возможности прикрепления файла к классу документа»
  • Функции, выполняемые Системой/dh-documents-service/Метод «Проверка возможности прикрепления файла к классу документа».md
  • Сервис dh-relations-service
    • Метод «Создать связь между двумя объектами»
    • Метод «Получить связь между двумя объектами»
    • Метод «Изменить/обновить атрибуты связи между двумя объектами»
    • Метод «Удалить связь между двумя объектами»
    • Метод «Получить список связей»
    • Метод «Получить разрешенные для связывания классы объектов»
    • Метод «Создать связи для объекта путем дублирования всех связей у исходного объекта»
  • Сервис dh-folders-service
    • Метод «Создать новую папку»
    • Метод «Получить папку по id»
    • Метод «Изменить папку»
    • Метод «Удалить папку с выбором действия содержимого папки»
    • Метод «Получить список корневых папок»
    • Метод «Получить контент папки»
    • Метод «Добавить контент к папке»
    • Метод «Смена родительской папки объекта»
    • Метод «Получить папки, в которых находится документ»
    • Метод «Получить путь до папки»
    • Метод «Удалить контент из папки»
    • Метод «Удалить контент из всех папок»
    • Метод «Проверить наличие доступа у пользователя к объекту для выполнения действия»
    • Метод «Получить токен для доступа к связанным объектам в других сервисах»
    • Метод «Проверить наличие доступа у пользователя к списку объектов для выполнения действий»
  • Сервис dh-collections-service
    • Метод «Получить атрибуты коллекции по id»
    • Метод «Изменить коллекцию»
    • Метод «Удалить коллекцию»
    • Метод «Получить список коллекций»
    • Метод «Создать новую коллекцию»
    • Метод «Получить список объектов коллекции»
    • Метод «Добавить объект в коллекцию»
    • Метод «Удалить объект из коллекции»
    • Метод «Проверить наличие доступа у пользователя к объекту для выполнения действия»
    • Метод «Получить токен для доступа к связанным объектам в других сервисах»
    • Метод «Проверить наличие доступа у пользователя к списку объектов для выполнения действий»
  • Сервис dh-favorites-service
    • Метод «Определить наличие объектов в избранном пользователя»
    • Метод «Получить содержимое списка избранного»
    • Метод «Добавить объект в избранное»
    • Метод «Удалить объект из избранного пользователя»
    • Метод «Удалить объект из избранного по id объекта»
  • Сервис dh-packager-service
    • Метод «Формирование архива для запрашиваемого списка файлов»
  • Сервис ldm-preview-service
    • Метод «Получение предпросмотра с водяными знаками»
    • Метод «Создание токена для предпросмотра»
  • Сервис ldm-comments-service
    • Метод «Создание нового комментария»
    • Метод «Получение комментариев по объекту»
    • Метод «Получить комментарий по id»
    • Метод «Обновить комментарий или его ответ по id»
    • Метод «Удаление комментария или его ответа по id и всех его подчиненных ответов»
    • Метод «Получение ответов на комментарий»
  • Сервис ldm-r7proxy-service
    • Метод «Запрос в командный сервис Р7»
    • Метод «Создать конфигурацию контента для редактирования»
    • Метод «Запрос для обратных вызовов сервиса Р7»
    • Метод «Получить конфигурацию контента для редактирования по id»
    • Метод «Загрузить контент документа из сервера документов Р7-Офис»
    • Метод «Создать список пользователей (соавторов)»
    • Метод «Получить список пользователей (соавторов)»
    • Метод «Добавить пользователя в список соавторов»
    • Метод «Удалить пользователя из списка пользователей (соавторов)»
    • Метод «Удалить список пользователей (соавторов)»
    • Метод «Создать конфигурацию контента для сравнения»
    • Метод «Получить конфигурацию контента для сравнения по id»
    • Метод «Получить статус документа в Р7»
    • Метод «Загрузить файл из Р7 в PWC»
    • Метод «Отменить загрузку файла из Р7 в PWC»
    • Метод «Заблокировать контент для загрузки из Р7 в LDM»
    • Метод «Загрузить контент Р7 в LDM и обновить файл у документа»
    • Метод «Разблокировать контент для загрузки из Р7 в LDM»
  • Сервис dh-object-info-service
    • Метод «Сброс кэша по объекту»
    • Метод «Получить информацию по различного типа объектам»
    • Метод «Сброс кэша по избранному пользователя»
  • Сервис ldm-shake-up-documents-service
    • Метод «Запустить выполнение задачи»
    • Метод «Получить список задач на перетряхивание документов»
    • Метод «Получить задачу на перетряхивание документов»
    • Метод «Удалить задачу на перетряхивание документов»
    • Метод «Отменить выполнение задачи на перетряхивание документов»
    • Метод «Опубликовать доменные события по отобранным документам»
    • Метод «Получить список отобранных документов»
    • Метод «Создать профиль задачи»
    • Метод «Получить профили задач»
    • Метод «Изменить профиль задачи»
    • Метод «Получить профиль задачи»
    • Метод «Удалить профиль задачи»
    • Метод «Создать условие в профиле задачи»
    • Метод «Получить условия профиля задачи»
    • Метод «Изменить условие в профиле задачи»
    • Метод «Получить условие профиля задачи»
    • Метод «Удалить условие профиля задачи»
  • Сервис ldm-document-content-transfer-service
    • Метод «Получить список задач на перемещение контента документов»
    • Метод «Получить все доменные события, которые обрабатываются сервисом»
    • Метод «Добавить событие в обработчике сервиса»
    • Метод «Получить событие из обработчика сервиса»
    • Метод «Удалить событие из обработчика сервиса»
    • Метод «Создать политику перемещения контента документов»
    • Метод «Получить политики перемещения контента документов»
    • Метод «Получить политику перемещения контента документов по уникальному идентификатору»
    • Метод «Изменить атрибуты политики перемещения контента документов по уникальному идентификатору»
    • Метод «Удалить политику перемещения контента документов по уникальному идентификатору и все связанные с ней условия»
    • Метод «Создать условие перемещения контента документов»
    • Метод «Получить условия перемещения контента документов»
    • Метод «Получить условие перемещения контента документов по уникальному идентификатору»
    • Метод «Изменить атрибуты условия перемещения контента документов по уникальному идентификатору»
    • Метод «Удалить условие перемещения контента документов по уникальному идентификатору»
  • Сервис ldm-uniqueness-service
    • Метод «Получить токен для работы с уникальными ключами, описанными в Системе»
    • Метод «Получить токен для работы с уникальными ключами, описанными в Системе для существующего объекта»
    • Метод «Завершить операцию с объектом»
    • Метод «Получить список наборов ключей»
    • Метод «Создать набор ключей с заданными параметрами»
    • Метод «Получить данные конкретного набора ключей»
    • Метод «Обновить набор ключей»
    • Метод «Удалить набор ключей»
    • Метод «Изменить состояние набора ключей»
    • Метод «Отменить регистрацию токена»
    • Метод «Пересчитать по объекту значения всех существующих ключей»
    • Метод «Пересчитать по объекту значения только ключей из переданных данных»
    • Метод «Удалить по объекту все значения уникальных ключей»
  • Сервис ldm-renditions-service
    • Метод «Создать альтернативное представление вместе с контентом»
    • Метод «Создать альтернативное представление с ранее созданным файлом»
    • Метод «Получить список альтернативных представлений объекта»
    • Метод «Получить информацию по альтернативному представлению»
    • Метод «Получить предпросмотр контента для альтернативного представления»
    • Метод «Получить контент альтернативного представления»
    • Метод «Удалить альтернативное представление»
  • Сервис ldm-print-forms-service
    • Метод «Создать задание на формирование печатной формы»
    • Метод «Получить список заданий текущего пользователя»
    • Метод «Получить данные задания»
    • Метод «Отменить задание»
    • Метод «Получить список шаблонов, доступных текущему пользователю»
    • Метод «Получить данные шаблона»
    • Метод «Получить список меток в шаблоне»
  • Сервис ldm-reports-service
    • Метод «Создать задание на формирование отчета»
    • Метод «Получить список заданий текущего пользователя»
    • Метод «Получить данные задания»
    • Метод «Получить файл готового отчета»
    • Метод «Повторить задание на формирование отчета»
    • Метод «Удалить задание на формирование отчета»
    • Метод «Получить список шаблонов, доступных текущему пользователю»
    • Метод «Получить данные шаблона»
    • Метод «Получить архив с шаблоном отчета»
    • Метод «Импортировать файл архива с шаблоном»
    • Метод «Обновить заданный шаблон из файла архива»
  • Сервис ldm-system-objects-service
  • Сервис ldm-personal-data-processing-service
    • Метод «Создать задачу»
    • Метод «Получить задачу»
    • Метод «Получить список задач»
    • Метод «Получить статус выполнения задачи»
    • Метод «Получить список пакетов объектов по задаче»
    • Метод «Отменить задачу»
    • Метод «Удалить задачу»
    • Метод «Запустить процесс мониторинга задач»
    • Метод «Запустить процесс мониторинга пакетов объектов»
    • Метод «Атрибутивный поиск по модели данных»
    • Метод «Проверить наличие доступа у пользователя к объекту для выполнения действия»
    • Метод «Получить токен для доступа к связанным объектам в других сервисах»
    • Метод «Проверить наличие доступа у пользователя к списку объектов для выполнения действий»
  • Сервис ldm-graphql-service
    • Метод «Генерация стандартного текста скрипта»
    • Метод «Зафиксировать версию сервиса»
    • Метод «Импортировать модуль из ZIP-файла с архивом»
    • Метод «Отключить модуль от сервиса»
    • Метод «Пересобрать все подключенные модули сервиса»
    • Метод «Подключить модуль к сервису»
    • Метод «Получение списка модулей»
    • Метод «Получить список элементов модуля»
    • Метод «Получить ссылку на скачивание ZIP-файла с архивом модуля»
    • Метод «Получить статус запроса»
    • Метод «Сгенерировать модуль»
    • Метод «Экспортировать модуль в виде ZIP-архива»