API: Редактирование задачи UserView

Обратитесь в службу поддержки Dotcom-Monitor, чтобы получить доступ к этой функции веб-API.

URL-адрес запроса

Поместить

https://api.dotcom-monitor.com/config_api_v1/task/{task_id}

Параметры пути

поле	Type	Обязательно	описание
task_id	струна	true	Уникальный идентификатор задачи мониторинга, которую вы хотите изменить.

Чтобы просмотреть идентификатор задачи из учетной записи dotcom-monitor, откройте целевое устройство в списке диспетчера устройств для редактирования. В адресной строке браузера вы увидите что-то вроде:

https://user.dotcom-monitor.com/ClientID/DeviceEdit?pid=dc7f4ff2ca944dekjh1078b96707002&deviceId=63698&taskId=132834

taskId=132834 — это идентификатор задачи.

Параметры запроса

поле Type Обязательно/Опционально описание

Времени ожидания

int32

необязательный

Содержит тайм-аут выполнения задачи в мс.

Device_Id

int32

Обязательно

Уникальный идентификатор устройства.

пример:

"Device_Id": 8692

Task_Type_Id

int32

Обязательно

Тип задачи.

имя

струна

необязательный

Описание задачи.

RequireRepeatVisit

булев

необязательный

Определяет состояние флага Simulate Return Visitor .

ВОЗМОЖНЫЕ ЗНАЧЕНИЯ:

true – мониторинг выполняется для имитации частого посетителя, у которого уже есть кэшированные элементы со страницы.
false – при каждом запуске моделируется новый посетитель.

WriteVideoOnEachMonitoring

булев

необязательный

Определяет состояние параметра «Записывать видео при каждом запуске ».

ВОЗМОЖНЫЕ ЗНАЧЕНИЯ:

true – для каждого сеанса мониторинга создается видеозапись.
false – система записывает видео о первом сеансе дня, в котором произошла ошибка, или о первой ошибке, обнаруженной в локации.

DisableHttpProxy (ОтключитьHttpProxy)

булев

необязательный

Позволяет активировать опцию прокси для отправки запросов на мониторинг через прокси или переключиться обратно на прямые запросы.

DisableVideoRecording (ОтключитьВидеозапись)

булев

необязательный

Позволяет отключить функцию записи видео.

ОтключитьСкриншоты

булев

необязательный

Позволяет отключить функцию скриншотов.

AbortOnError

булев

необязательный

Указывает, активирован ли параметр «Прервать сценарий при первой ошибке».

ВОЗМОЖНЫЕ ЗНАЧЕНИЯ:

true – выполнение скрипта будет остановлено при первой ошибке мониторинга.
false – выполнение скрипта будет продолжаться до тех пор, пока не истечет время ожидания.

DNSРесольвеМод

булев

необязательный

ВОЗМОЖНЫЕ ЗНАЧЕНИЯ:

Устройство Кэшировано
Не кэшированный
TTL Кэшированный
Внешний DNS-сервер

Подробные объяснения см. в статье Параметр режима DNS.

DNSserverIP

струна

0ptional

Поле для пользовательского IP-адреса DNS-сервера. Подробные объяснения см. в статье Параметр режима DNS.

CustomDNSHosts

струна

необязательный

Содержит список пар IP-адресов и имен узлов, которые используются для настройки сопоставления IP-адресов с именами узлов.

Текст запроса

API Dotcom-Monitor принимает двоичные файлы, загруженные с телом запроса. Чтобы загрузить ES-скрипт вместе с запросом в Dotcom-Monitor:

Создайте или отредактируйте сценарий EveryStep с помощью инструмента сценариев EveryStep.
Загрузите скрипт на свой компьютер и сохраните в файл dmuv/dmes.
В клиенте API выберите, чтобы отправить файл dmuv/dmes в виде двоичного файла в тексте запроса. Если клиент API не поддерживает двоичный метод, используйте альтернативный подход.

Пример запроса

curl --location --request PUT "https://api.dotcom-monitor.com/config_api_v1/task/12365?Device_Id=16826&Task_Type_Id=21&Timeout=55000&Name=uploaded_dmes_script" ^
--header "Content-Type: application/octet-stream" ^
--header "Cookie: DANA-AUTH-API-COOKIE=7efad88951954e61a1235f43219882f34; DANA-AUTH-COOKIE=21c34cc69cdd4123448eaa5c519a824e" ^
--data "@/C:/Users/dm_admin/ES_Scripts/everystep-script.dmes"

Загрузка ES-скрипта в виде данных в кодировке Base64

Если ваш API-клиент не поддерживает двоичный метод, вы можете загрузить свой ES-скрипт в Dotcom-Monitor в качестве параметра тела JSON в формате Base64. Обратите внимание, что в этом случае все параметры запроса должны передаваться в теле запроса, а не в запросе.

URL-адрес запроса

Поместить

https://api.dotcom-monitor.com/config_api_v1/task/{task_id}

Параметры пути

поле	Type	Обязательно	описание
task_id	струна	true	Уникальный идентификатор задачи мониторинга, которую вы хотите изменить.

Параметры заголовка

Content-Type: application/json

Пример тела JSON

{ 
    "Device_Id": 3153, 
    "Task_Type_Id": 21, 
    "Name": "dotcom-monitor.com", 
    "Timeout": 1200, 
    "base64dmuv": "AAEAAAD/////AQAAAAAAAAAEAQAAAAxTeXN0ZW0uSW50MzIBAAAAB21fdmFsdWUACAIAAAALAAEAAAD/////AQAAAAAAAAAMAgAAAERfT1FMX0R5bmFtaWNfLCB.......1bHR1cmU9bmV1dHJh"
    
}

Параметры кузова

Обязательные параметры JSON приведены ниже. Чтобы добавить дополнительные параметры в тело, см. описание полей в API: UserView Task JSON Sample.

поле Type Обязательно/Опционально описание

База64DMUV

струна

Обязательно

Содержит ES-скрипт в формате Base64.

Пожалуйста, ознакомьтесь с руководством по преобразованию скрипта EveryStep в Base64.

Device_Id

int32

Обязательно

Уникальный идентификатор устройства.

пример:

"Device_Id": 8692

Task_Type_Id

int32

Обязательно

Тип задачи.

Чтобы преобразовать сценарий в формат Base64, необходимо сначала импортировать сценарий из инструмента в файл *.dmuv (ES Desktop) или *.dmes (ES Web). Пожалуйста, выполните следующие действия:

Создайте или отредактируйте сценарий EveryStep с помощью инструмента сценариев EveryStep.
Загрузите скрипт на свой компьютер и сохраните в файл dmuv/dmes.
Используйте кодировщик для преобразования файла dmuv/dmes в формат Base64.
Скопируйте закодированное содержимое в параметр base64dmuv запроса JSON.

В качестве альтернативы, если у вас возникли проблемы с преобразованием файла сценария в Base64, вы можете скачать наш кодировщик Base64 здесь. После загрузки используйте кодировщик для преобразования файла ES, как описано ниже:

Откройте командную строку и укажите путь к кодировщику .exe файл encoding_checker.exe.
Укажите полный путь к загруженному файлу dmuv/dmes в качестве аргумента (например, “g:\Temp9\login_check.dmuv”).
Чтобы сохранить преобразованный сценарий в файл, укажите путь к файлу.

Реакция на успех

Пример ответа

{
    "Success": true,
    "Result": "Task 12365 has been updated"
}