Wenden Sie sich an das Dotcom-Monitor-Supportteam, um Zugriff auf diese Web-API-Funktionalität zu erhalten.

URL anfordern

PUT https://api.dotcom-monitor.com/config_api_v1/tasks

Abfrage-Parameter

Parameter Erforderlich beschreibung
Device_Id

true

 Die eindeutige ID des Überwachungsgeräts, unter dem die Aufgabe erstellt wird.
Task_Type_Id

true

 Der Typ der Aufgabe.

Für UserView:

Task_Type_Id=21
Timeout

wahlfrei

 Das Zeitlimit für die Aufgabenausführung in ms.
name

wahlfrei

 Die Aufgabenbeschreibung.

Anforderungstext

Die Dotcom-Monitor-API akzeptiert Binärdateien, die mit einem Anforderungstext hochgeladen werden. So laden Sie ein ES-Skript zusammen mit Ihrer Anfrage auf Dotcom-Monitor hoch:

  1. Erstellen oder bearbeiten Sie ein EveryStep-Skript mit dem EveryStep Scripting Tool.
  2. Laden Sie das Skript auf Ihren Computer herunter und speichern Sie es in einer dmuv/dmes-Datei.
  3. Wählen Sie in einem API-Client aus, dass die dmuv/dmes-Datei als Binärdatei im Anforderungstext gesendet werden soll. Wenn Ihr API-Client die binäre Methode nicht unterstützt, verwenden Sie einen alternativen Ansatz.
Beispiel für eine Anfrage
curl --location --request PUT "https://api.dotcom-monitor.com/config_api_v1/tasks?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"

Hochladen von ES-Skripten als Base64-kodierte Daten

Wenn Ihr API-Client die binäre Methode nicht unterstützt, können Sie Ihr ES-Skript als JSON-Textparameter im Base64-Format in Dotcom-Monitor hochladen. Beachten Sie, dass in diesem Fall alle Anforderungsparameter im Anforderungstext (nicht in der Abfrage) übergeben werden sollten.

URL anfordern

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

Pfadparameter

Feld drucktype Erforderlich beschreibung
task_id

Schnur

true

 Die eindeutige ID einer Überwachungsaufgabe, die Sie bearbeiten möchten.

Header-Parameter

Content-Type: application/json

Beispiel für JSON-Text

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

Körperparameter

Feld drucktype Erforderlich/Optional beschreibung
Timeout

int32

wahlfrei

 Enthält Zeitüberschreitung bei der Aufgabenausführung in ms.
base64dmuv Schnur Erforderlich Enthält EveryStep-Skript im Base64-Format.

Bitte beachten Sie die Richtlinie zum Konvertieren von EveryStep-Skripten in Base64.
Device_Id

int32

Erforderlich

 Die eindeutige Geräte-ID.

Beispiel:
"Device_Id": 8692
Task_Type_Id

int32

Erforderlich

 Der Typ der Aufgabe.
name

Schnur

wahlfrei

 Die Aufgabenbeschreibung.

Um das Skript in das Base64-Format zu konvertieren, müssen Sie das Skript zuerst aus dem Tool in eine *.dmuv (ES Desktop) oder *.dmes (ES Web) Datei importieren. Bitte befolgen Sie die folgenden Schritte:

  1. Erstellen oder bearbeiten Sie ein EveryStep-Skript mit dem EveryStep Scripting Tool.
  2. Laden Sie das Skript auf Ihren Computer herunter und speichern Sie es in einer dmuv/dmes-Datei.
  3. Verwenden Sie einen Encoder, um die dmuv/dmes-Datei in das Base64-Format zu konvertieren.
  4. Kopieren Sie einen codierten Inhalt in den base64dmuv-Parameter Ihrer JSON-Anforderung.

Wenn Sie Probleme bei der Konvertierung der Skriptdatei in Base64 haben, können Sie alternativ unseren Base64-Encoder hier herunterladen. Verwenden Sie nach dem Herunterladen den Encoder, um die ES-Datei wie folgt zu konvertieren:

  1. Öffnen Sie die Befehlszeile, und geben Sie einen Pfad zum Encoder .exe Datei encoding_checker.exe an.
  2. Geben Sie den vollständigen Pfad zur heruntergeladenen dmuv/dmes-Datei als Argument an (z. B. “g:\Temp9\login_check.dmuv”).
  3. Um ein konvertiertes Skript in einer Datei zu speichern, geben Sie einen Pfad zur Datei an.

Erfolgsreaktion

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