Встановити загальну інформацію для списку моніторингу

Оператор с ключем "key" повинен мати право змінювати списки моніторингу.
Якщо mt_id = null - створює новий список з переданими даними. Перелік суб’єктів моніторингу в ньому порожній. Всі поля та переліки, що не були передані - встановлюються порожніми. ID нового списку повертається в new_mt_id.
Якщо mt_id != null – встановлює/змінює налаштування джерел моніторингу та інші параметри моніторингу за переданим mt_id. Всі параметри що не передані - не змінюються. Передавати mt_id можна лише тих моніторингів, які належать безпосередньо клієнту. Дізнатись які mt_id належать клієнту можна за допомогою api /monitoring/listinfo/get.
Якщо передано deactivated_by_user=true/false - моніторинг буде деактивовано/активовано.
Якщо передано обидва параметри in_separate_letter, message_format не порожні - видає помилку.
init_back_day_limit – встановлює період часу за який повернути події, що були зафіксовані до моменту ініціалізації нових суб’єктів пошуку. Можна передати одну з констант: none, any_time, current_year, current_quarter, current_month. Або ж ціле число - кількість днів до поточного. Дані, які раніше за переданий період при ініціалізації нових суб'єктів використовуватись не будуть. Існує виключення для трьох видів (джерел) моніторингу: MEDRCH, MEDRTC та MEDRN. По ним отримати події, які трапились до моменту ініціалізації отримати не можливо.

Request

Authorization

Add parameter in query

key

Example:

key: ********************

Body Params application/json

mt_id

string

optional

ID списку моніторингу

receiver_name

string

optional

назва отримувача списку

receiver_code

string

optional

код отримувача списку

receiver_emails

array[string]

optional

email'и на які відправляти повідомлення з результатами

list_name

string

optional

назва списку

list_comment

string

optional

комментар до списку

kinds

array [object {6}]

optional

види (джерела) моніторингу

string

required

id виду джерела моніторингу

schedule_id

string

required

id розкладу моніторингу

filter_id

string | null

required

id фільтру для подій

in_separate_letter

boolean

deprecated

застаріле! ознака окремого листа

message_format

enum<string>

required

формат повідомлення: одно з "MailBodyCmn", "MailBodySep", "XlsxAttached"

Allowed values:

MailBodyCmnMailBodySepXlsxAttached

init_back_day_limit

string

required

свіжість даних що використовуються при ініціалізації

deactivated_by_user

boolean

optional

деативувати/активувати перелік

language

string

required

3 літ. ISO 639-1

key

string

required

ключ доступу

Example

{
    "mt_id": null,
    "receiver_name": "Одержувач!",
    "receiver_code": "",
    "receiver_emails": [
        "??????@gmail.com"
    ],
    "list_name": "Назва переліку",
    "list_comment": "Коментар",
    "kinds": [
        {
            "id": "MSFGO",
            "schedule_id": "1",
            "filter_id": "17",
            "in_separate_letter": false,
            "message_format": "MailBodyCmn",
            "init_back_day_limit": "365"
        }
    ]
}

Responses

🟢200Success

application/json

Body

answer

object

required

new_mt_id

integer

required

ID списку моніторингу

status

enum<string>

required

Allowed values:

SuccessWarningError

statusCode

integer

required

message

string

optional

Example

{"status":"Success","statusCode":301,"message":"","answer":{"new_mt_id":291}}