Обязательные маршруты проксирования¶
Перечень обязательных маршрутов проксирования представлен в таблице ниже.
Обязательные маршруты проксирования
| Название маршрута | Код | Передаваемые данные | URL |
|---|---|---|---|
| Получить превью файла | get-file-preview | { "query": { "id": "string", "versionId": "string", "serviceName": "string" } } |
GET https://адрес-сервера/dh-gateway-api-service/dh-documents-service/api/v1/documents/@query.id/versions/@query.versionId/preview |
| Получить контент файла | get-file-content | { "query": { "fileId": "string" } } |
GET https://адрес-сервера/dh-gateway-api-service/dh-files-service/api/v1/files/@query.fileId/content |
| Проверить хэш файла | check-file-hash | { "query": { "fileId": "string" } } |
POST https://адрес-сервера/dh-gateway-api-service/dh-files-service/api/v1/files/@query.fileId/checkHash |
| Получить список политик размещения | get-file-policies | { "query": { "page": "string", "size": "string", "sort": "string" } } |
GET https://адрес-сервера/dh-gateway-api-service/dh-files-service/api/v1/policies?getSoftDeleted=false&page=@query.page&size=@query.size&sort=@query.sort |
| Получить политику размещения по идентификатору | get-file-policy-by-id | { "query": { "policyId": "string" } } |
GET https://адрес-сервера/dh-gateway-api-service/dh-files-service/api/v1/policies/@query.policyId |
| Получить список ЭП | get-file-signatures | { "query": { "fileId": "string" } } | GET https://адрес-сервера/dh-gateway-api-service/ldm-signatures-storage-service/api/v1/signatures?signedObjectId=@query.fileId |
| Получить ЭП | get-signature | { "query": { "signatureId": "string" } } |
GET https://адрес-сервера/dh-gateway-api-service/ldm-signatures-storage-service/api/v1/signatures/@query.signatureId |
| Скачать ЭП | get-signature-content | { "query": { "signatureId": "string" } } |
GET https://адрес-сервера/dh-gateway-api-service/ldm-signatures-storage-service/api/v1/signatures/@query.signatureId/content |
| Создать ЭП | create-signature | { "payload": { "signerLogin": "string", "certificateCenterName": "string", "certificateNumber": "string", "certificateStartDate": "string", "certificateEndDate": "string", "algorithm": "string" } } |
POST https://адрес-сервера/dh-gateway-api-service/ldm-signatures-storage-service/api/v1/signatures |
| Изменить ЭП | update-signature | { "query": { "signatureId": "string" }, "payload": { "signerLogin": "string", "certificateCenterName": "string", "certificateNumber": "string", "certificateStartDate": "string", "certificateEndDate": "string", "algorithm": "string" } } |
PUT https://адрес-сервера/dh-gateway-api-service/ldm-signatures-storage-service/api/v1/signatures/@query.signatureId |
| Удалить ЭП | delete-signature | { "query": { "signatureId": "string" } } |
DELETE https://адрес-сервера/dh-gateway-api-service/ldm-signatures-storage-service/api/v1/signatures/@query.signatureId |
| Получить классы сервиса из реестра | get-application-classes | { "query": { "serviceName": "string", "fields": "string" } } |
GET https://адрес-сервера/dh-gateway-api-service/dh-registry-service/api/v1/applications/@query.serviceName/classes?fields=@query.fields |
| Получить класс сервиса по коду | get-application-class-by-code | { "query": { "serviceName": "string", "className": "string", "fields": "string" } } |
GET https://адрес-сервера/dh-gateway-api-service/dh-registry-service/api/v1/applications/@query.serviceName/classes/@query.className?fields=@query.fields |
| Получить приложение по коду класса | search-applications-by-class-codes | { "query": { "classCode": "string", "filterRequestedClasses": "boolean", "fields": "string" } } |
GET https://адрес-сервера/dh-gateway-api-service/dh-registry-service/api/v1/applications/search/byClassCodes?classCode=@query.classCode&filterRequestedClasses=@query.filterRequestedClasses&fields=@query.fields |
| Получить классы сервиса из модели данных | get-application-classes-from-data-model | { "query": { "page": "string", "size": "string", "sort": "string", "rootObjectClass": "string" } } |
GET https://адрес-сервера/dh-gateway-api-service/dh-datamodel-service/api/models/object-classes?sort=@query.sort&rootObjectClass=@query.rootObjectClass&size=@query.size&page=@query.page |
| Получить конфигурацию по имени сервиса | get-config-server-by-service-name | { "query": { "serviceName": "string" } } |
GET https://адрес-сервера/dh-gateway-api-service/dh-configurations-service/config-server/@query.serviceName/default |
| Получить начальную конфигурацию Р7 | get-initial-r7-config | { "query": { "r7ContentId": "string" } } |
GET https://адрес-сервера/dh-gateway-api-service/ldm-r7proxy-service/api/v1/contents/@query.r7ContentId/config |
| Получить конфигурацию Р7 | get-r7-config | { "query": { "serviceName": "string", "objectId": "string", "versionId": "string", "fileId": "string", "editorType": "string" } } |
GET https://адрес-сервера/dh-gateway-api-service/@query.serviceName/api/v1/documents/@query.objectId/versions/@query.versionId/files/@query.fileId/contentConfigR7?type=@query.editorType |
| Получить конфигурацию Р7 для соавтора | get-coauthor-r7-config | { "query": { "contentId": "string", "coauthorId": "string", "personalConfigEnabled": "string", "mode": "string" } } |
GET https://адрес-сервера/dh-gateway-api-service/@query.serviceName/api/v1/documents/@query.objectId/versions/@query.versionId/files/@query.fileId/contentConfigR7?type=@query.editorType |
| Получить статус контента Р7 | get-r7-content-status | { "query": { "r7ContentId": "string" } } |
GET https://адрес-сервера/dh-gateway-api-service/ldm-r7proxy-service/api/v1/@query.r7ContentId/content-status |
| Сбросить изменения контента Р7 | discard-r7-changes | { "query": { "r7ContentId": "string" } } |
PATCH https://адрес-сервера/dh-gateway-api-service/ldm-r7proxy-service/api/v1/@query.r7ContentId/discard-changes |
| Загрузить контент Р7 | upload-r7-changes | { "query": { "contentId": "string" } } |
POST https://адрес-сервера/dh-gateway-api-service/ldm-r7proxy-service/api/v1/contents/@query.contentId/upload?ignoreState=true |
| Заблокировать конфигурацию Р7 | block-r7-changes | { "query": { "contentId": "string" } } |
POST https://адрес-сервера/dh-gateway-api-service/ldm-r7proxy-service/api/v1/contents/@query.contentId/block |
| Получить соавторов по идентификатору Р7 | get-coauthors-by-content-id | { "query": { "contentId": "string" } } |
GET https://адрес-сервера/dh-gateway-api-service/ldm-r7proxy-service/api/v1/coauthors/@query.contentId |
| Создать список соавторов Р7 | create-coauthors-list | { "query": { "contentId": "string" } } |
POST https://адрес-сервера/dh-gateway-api-service/ldm-r7proxy-service/api/v1/coauthors/@query.contentId |
| Добавить соавтора Р7 | add-coauthor | { "query": { "contentId": "string", "listId": "string" }, "body": { "firstName": "string", "lastName": "string", "username": "string", "email": "string" } } |
POST https://адрес-сервера/dh-gateway-api-service/ldm-r7proxy-service/api/v1/coauthors/@query.contentId/@query.listId/person |
| Удалить соавтора Р7 | delete-coauthor | { "query": { "contentId": "string", "listId": "string", "personId": "string" } } |
DELETE https://адрес-сервера/dh-gateway-api-service/ldm-r7proxy-service/api/v1/coauthors/@query.contentId/@query.listId/person/@query.personId |
| Проверить доступность контента Р7 | check-r7-content-availability | { "query": { "contentId": "string" } } |
GET https://адрес-сервера/dh-gateway-api-service/ldm-r7proxy-service/api/v1/contents/@query.contentId/state |
| Получить папку | get-folder | { "query": { "folderId": "string" } } |
GET https://адрес-сервера/dh-gateway-api-service/dh-folders-service/api/v1/folders/@query.folderId |
| Получить контент папки | get-folder-content | { "query": { "folderId": "string", "page": "string", "size": "string", "sort": "string" } } |
GET https://адрес-сервера/dh-gateway-api-service/dh-folders-service/api/v1/folders/@query.folderId/content?page=@query.page&size=@query.size&sort=@query.sort |
| Получить сохраненные поиски | get-saved-searches | { "query": { "page": "string", "size": "string", "uiQueryType": "string", "targetUiCollection": "string", "offset": "string" } } |
GET https://адрес-сервера/dh-gateway-api-service/dh-queries-service/api/v1/queries/personal?page=@query.page&size=query.size&uiQueryType=@query.uiQueryType&targetUiCollection=@query.targetUiCollection |
| Получить сохраненный поиск | get-saved-search-by-id | { "query": { "id": "string" } } |
GET https://адрес-сервера/dh-gateway-api-service/dh-queries-service/api/v1/queries/personal/@query.id |
| Создать сохраненный поиск | create-saved-search | { "payload": { "name": "string", "description": "string", "userName": "string", "query": "object", "targetUiCollection": "string", "uiQueryType": "string" } } |
POST https://адрес-сервера/dh-gateway-api-service/dh-queries-service/api/v1/queries/personal |
| Обновить сохраненный поиск | update-saved-search-by-id | { "query": { "id": "string" }, "payload": { "name": "string", "description": "string", "userName": "string", "query": "object", "targetUiCollection": "string", "uiQueryType": "string" } } |
PUT https://адрес-сервера/dh-gateway-api-service/dh-queries-service/api/v1/queries/personal/@query.id |
| Получить пользовательские настройки для текущего пользователя | get-current-user-settings | { "query": { "page": "string", "size": "string", "containerType": "string", "container": "string" } } |
GET https://адрес-сервера/dh-gateway-api-service/ldm-user-settings-service/api/v1/settings/current-user?page=@query.page&size=@query.size&containerType=@query.containerType&container=@query.container |
| Удалить пользовательскую настройку | delete-user-setting-by-id | { "query": { "id": "string" } } |
DELETE https://адрес-сервера/dh-gateway-api-service/ldm-user-settings-service/api/v1/settings/@query.id |
| Создать пользовательскую настройку | create-user-setting | { "payload": { "containerType": "string", "key": "string", "isGeneral": "boolean", "description": "string", "application": "string", "container": "string", "userName": "string", "value": "object" } } |
POST https://адрес-сервера/dh-gateway-api-service/ldm-user-settings-service/api/v1/settings |
| Обновить пользовательскую настройку | update-user-setting-by-id | { "query": { "id": "string" }, "payload": {} } |
PUT https://адрес-сервера/dh-gateway-api-service/ldm-user-settings-service/api/v1/settings/@query.id |
| Получить пользователей | get-users | { "query": {} } |
GET https://адрес-сервера/dh-gateway-api-service/ldm-users-info-service/api/v2/users?search=@query.search |
Если вместо статических сервисов в Системе разработаны кастомные, то их необходимо указывать в URL после адреса сервера: «https://адрес-сервера/сервис-посредник/наименование-сервиса/».