Runs & Ergebnisse

Runs & Ergebnisse - DQE One Standalone API

Verfolgen Sie die Ausführung eines mit runProcess gestarteten Process und rufen Sie anschließend dessen Ergebnis ab.

{DOMAIN} ist der Hostname Ihres eigenen DQE One Standalone Servers — er wird selbst gehostet, daher hängt dieser Wert von Ihrer Bereitstellung ab. {EMAIL} ist Ihr DQE One Login und {API_TOKEN} der Token, der unter My Account > API Token generiert wird.

Zugehörige Dokumentation: DQE One Standalone API — Introduction, Files, Credentials, Processes, Runs & results, RuleSets.

Direkt zugetRuns

Run-Status abrufen - DQE One Standalone API

Gibt einen Run oder die Liste Ihrer Runs zurück. Fragen Sie ihn nach runProcess regelmäßig ab, bis der Status Finished oder Failed lautet.

getRuns

Direkt zu Parameter Antwort Beispiel Fehler ▶ API testen

Anfrage

Senden Sie eine GET-Anfrage. Übergeben Sie id für einen einzelnen Run; andernfalls erhalten Sie ein Array mit allen Ihren Runs (keine Paginierung).

Filter: processId beschränkt die Liste auf einen Process; kind filtert nach der Art des Process, wird aber ignoriert, wenn processId vorhanden ist (sie lassen sich nicht kombinieren). count ist die Anzahl der Zeilen in der Ausgabedatei, nicht die Anzahl der verarbeiteten Datensätze. Ein Fortschrittsprozentsatz oder detaillierte Metriken werden hier nicht bereitgestellt; Details sehen Sie in der Weboberfläche ein.

GEThttps://{DOMAIN}/api/Run/get?id={id}&processId={processId}&kind={kind}

Codebeispiele

Run-Status abrufen

cURLJavaScriptPythonPHPNode.jsJavaC#Go

                curl -u "{EMAIL}:{API_TOKEN}" \
                "https://{DOMAIN}/api/Run/get?id=101"
              

                fetch("https://{DOMAIN}/api/Run/get?id=101", {
                method: "GET",
                headers: {
                "Authorization": "Basic " + btoa("{EMAIL}:{API_TOKEN}")
                }
                })
                .then(r => r.text())
                .then(data => console.log(data));
              

                import requests

                response = requests.get(
                "https://{DOMAIN}/api/Run/get",
                auth=("{EMAIL}", "{API_TOKEN}"),
                params={"id": "101"},
                )
                print(response.status_code, response.text)
              

                <?php
                $ch = curl_init("https://{DOMAIN}/api/Run/get?id=101");
                curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "GET");
                curl_setopt($ch, CURLOPT_USERPWD, "{EMAIL}:{API_TOKEN}");
                curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
                $response = curl_exec($ch);
                $status = curl_getinfo($ch, CURLINFO_HTTP_CODE);
                curl_close($ch);
                echo $status . " " . $response;
              

                const axios = require('axios');

                axios({
                method: "get",
                url: "https://{DOMAIN}/api/Run/get",
                auth: { username: "{EMAIL}", password: "{API_TOKEN}"
                },
                params: { "id": "101" }
                })
                .then(res => console.log(res.status, res.data))
                .catch(err => console.log(err.response ? err.response.status
                : err.message, err.response && err.response.data));
              

                import java.net.URI;
                import java.net.http.*;
                import java.util.Base64;

                String auth = Base64.getEncoder().encodeToString("{EMAIL}:{API_TOKEN}".getBytes());

                HttpRequest request = HttpRequest.newBuilder()
                .uri(URI.create("https://{DOMAIN}/api/Run/get?id=101"))
                .header("Authorization", "Basic " + auth)
                .method("GET", HttpRequest.BodyPublishers.noBody())
                .build();

                HttpResponse<String> response = HttpClient.newHttpClient().send(request,
                HttpResponse.BodyHandlers.ofString());
                System.out.println(response.statusCode() + " " +
                response.body());
              

                using System.Net.Http;
                using System.Net.Http.Headers;
                using System.Text;

                using var client = new HttpClient();
                client.DefaultRequestHeaders.Authorization = new
                AuthenticationHeaderValue(
                "Basic", Convert.ToBase64String(Encoding.UTF8.GetBytes("{EMAIL}:{API_TOKEN}")));

                using var request = new HttpRequestMessage(HttpMethod.Get,
                "https://{DOMAIN}/api/Run/get?id=101");

                var response = await client.SendAsync(request);
                Console.WriteLine((int)response.StatusCode + " "
                + await response.Content.ReadAsStringAsync());
              

                package main

                import (
                "fmt"
                "io"
                "net/http"
                )

                func main() {

                req, _ := http.NewRequest("GET", "https://{DOMAIN}/api/Run/get?id=101",
                nil)
                req.SetBasicAuth("{EMAIL}", "{API_TOKEN}")

                resp, err := http.DefaultClient.Do(req)
                if err != nil {
                panic(err)
                }
                defer resp.Body.Close()

                out, _ := io.ReadAll(resp.Body)
                fmt.Println(resp.StatusCode, string(out))
                }
              

Parameter

Feld	Beschreibung	Typ	Pflicht / Opt.
id	Run-ID (gibt ein einzelnes Objekt zurück).	Integer	Optional
processId	Nach Process filtern.	Integer	Optional
kind	Nach Art des Process filtern (wird ignoriert, wenn processId gesetzt ist).	String	Optional

Authentifizierung: HTTP Basic — Ihre DQE One E-Mail-Adresse und Ihr API token (My Account > API Token). Siehe den Artikel Introduction.

Antwort

Ein Run (mit id) oder ein Array von Runs. HTTP-Status 200.

Schlüssel	Beschreibung	Typ
id		Integer
processId		Integer
type		String
startedOn		String
updatedOn		String
status	Freitext. Beobachtet: Started, Creating DQE Fields, Reading, In Progress, Writing, Finished, Failed.	String
outputFile		String
count	Zeilen in der Ausgabedatei.	Integer
error		String

Statuswerte

status ist Freitext; diese Werte werden derzeit erzeugt.

status	Bedeutung
Started	Der Run ist in der Warteschlange oder beginnt gerade.
Creating DQE Fields	Erster Run auf einer CRM-/Datenbankquelle: DQE One fügt seine Ergebnisfelder hinzu (siehe Field Reference in DQE One Standalone).
Reading	Datensätze werden aus der Quelle gelesen.
In Progress	Verarbeitung läuft.
Writing	Ergebnisse werden geschrieben.
Finished	Abgeschlossen. `outputFile` und `count` sind gefüllt.
Failed	Mit einem Fehler beendet; siehe `error`.

Abfragemuster (Polling)

            run_id=$(curl -s -u "$EMAIL:$TOKEN" "https://$DOMAIN/api/Process/run?id=42"
            | jq -r .run_id)
            while true; do
            status=$(curl -s -u "$EMAIL:$TOKEN" "https://$DOMAIN/api/Run/get?id=$run_id"
            | jq -r .status)
            echo "$status"; [ "$status" = "Finished" ] || [ "$status"
            = "Failed" ] && break
            sleep 5
            done
            curl -u "$EMAIL:$TOKEN" -OJ "https://$DOMAIN/api/File/get?processId=42"
          

Jobs laufen pro Benutzer nacheinander, sodass ein Run im Status Started bleiben kann, während ein früherer Job abgeschlossen wird. Laden Sie das Ergebnis herunter mit Files → Download a process result.

Antwortbeispiel

Beispielantwort

              {
              "id": 101,
              "processId": 42,
              "type":
              "check_email",
              "startedOn":
              "2026-11-10T09:00:00Z",
              "updatedOn":
              "2026-11-10T09:01:12Z",
              "status":
              "Finished",
              "outputFile":
              "out.csv",
              "count": 1500,
              "error": null
              }
            

Fehler

HTTP	Body / Bedeutung
401	`Unauthorized`
404	`Run not found`

API testen

Klicken Sie auf die Schaltfläche unten, um diesen Endpoint live in Ihrem Browser zu testen.

Hinweis: Diese Konsole sendet aus Ihrem Browser eine echte Anfrage an Ihren eigenen Server, mit Ihrem echten API token.

Konsole öffnen

API-Konsole GET /api/Run/get

Server-Domain

Authentifizierung (HTTP Basic)

E-Mail erforderlich

API token erforderlich

Parameter

processId

kind

cURLJSPythonPHPNodeJavaC#Go

Runs & Ergebnisse

getRuns

Anfrage

Codebeispiele

Parameter

Antwort

Statuswerte

Abfragemuster (Polling)

Antwortbeispiel

Fehler

API testen

Siehe auch

War dieser Beitrag hilfreich?

Vorheriger Artikel

Nächster Artikel