Метод «Создать подписку пользователя на события Системы»¶
Endpoint: POST {hostname}/dh-subscriptions-service/api/v2/subscriptions
Метод позволяет создать новую подписку пользователя на события Системы.
Более подробное описание метода находится в yaml файле «subscriptions_service», который расположен в папке с документацией.
Маппинг параметров запроса
| Входящие параметры | Способ передачи параметров | Требования к заполнению |
|---|---|---|
| name | Body | Наименование подписки. Значение согласно описанию в зависимости от потребностей клиента |
| subjectName | Body | Наименование субъекта. Значение согласно описанию в зависимости от потребностей клиента |
| subjectType | Body | Тип субъекта. Доступные значения: User, group, event_owner |
| isActive | Body | Признак активности подписки. Значение согласно описанию в зависимости от потребностей клиента |
| subPreferences: · eventClass · serviceName · data: - objectClass - operands: * code * value * function * objectClass - operators · actionTypes: - id - actionType - data: * additionalProp1 * additionalProp2 * additionalProp3 |
Body | Список моделей для создания настроек подписки: - класс события; - наименование сервиса; - структура группы, содержащая параметры поискового запроса; - список типов каналов для уведомлений |
Пример запроса:
curl --location 'https://docshouse-test.k8s.lan.lanit.ru/dh-gateway-api-service/dh-subscriptions-service/api/v3/subscriptions' \
-header 'accept: application/json' \
-header 'Content-Type: application/json' \
-data '{
"name": "testSub",
"isActive": true,
"subjectName": "testU",
"subjectType": "USER",
"subPreferences": [
{
"eventClass": "dh-folders-service.DeleteFolderEvent.Success",
"serviceName": "folders",
"data": {
"objectClass": "testClass",
"operands": [
{
"code": "code49",
"value": { subtest 501},
"function": "LIKE"
}
],
"operators": [
"AND"
]
},
"actionTypes": [
{
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"actionType": "NotificationSmsActionType",
"data": {
"additionalProp1": {},
"additionalProp2": {},
"additionalProp3": {}
}
}
]
}
]
}'