Runs & results

Runs & results - DQE One Standalone API

Siga la ejecución de un process iniciado con runProcess y luego obtenga su resultado.

{DOMAIN} es el nombre de host de su propio servidor DQE One Standalone — es autoalojado, por lo que este valor depende de su implementación. {EMAIL} es su usuario de DQE One y {API_TOKEN} el token generado en My Account > API Token.

Documentación relacionada: DQE One Standalone API — Introduction, Files, Credentials, Processes, Runs & results, RuleSets.

Ir agetRuns

Obtener el estado de un run - DQE One Standalone API

Devuelve un run o la lista de sus runs. Consúltelo periódicamente después de runProcess hasta que el estado sea Finished o Failed.

getRuns

Ir a Parámetros Respuesta Ejemplo Errores ▶ Probar la API

Solicitud

Envíe una solicitud GET. Indique id para un único run; de lo contrario, obtendrá un array con todos sus runs (sin paginación).

Filtros: processId limita la lista a un process; kind filtra por tipo de process pero se ignora cuando processId está presente (no se combinan). count es el número de filas del archivo de salida, no el número de registros procesados. Aquí no se expone ningún porcentaje de progreso ni métricas detalladas; consulte los detalles en la interfaz web.

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

Ejemplos de código

Obtener el estado de un run

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))
                }
              

Parámetros

Campo	Descripción	Tipo	Obl / Opc
id	Id del run (devuelve un único objeto).	Integer	Opcional
processId	Filtrar por process.	Integer	Opcional
kind	Filtrar por tipo de process (se ignora si se indica processId).	String	Opcional

Autenticación: HTTP Basic — su email de DQE One y su API token (My Account > API Token). Consulte el artículo de Introducción.

Respuesta

Un run (con id) o un array de runs. Estado HTTP 200.

Clave	Descripción	Tipo
id		Integer
processId		Integer
type		String
startedOn		String
updatedOn		String
status	Texto libre. Valores observados: Started, Creating DQE Fields, Reading, In Progress, Writing, Finished, Failed.	String
outputFile		String
count	Filas del archivo de salida.	Integer
error		String

Valores de estado

status es texto libre; actualmente se producen estos valores.

status	Significado
Started	El run está en cola o acaba de comenzar.
Creating DQE Fields	Primer run sobre una fuente CRM/base de datos: DQE One está añadiendo sus campos de resultado (véase Field Reference in DQE One Standalone).
Reading	Lectura de registros de la fuente.
In Progress	En proceso.
Writing	Escritura de resultados.
Finished	Terminado. `outputFile` y `count` están rellenados.
Failed	Detenido por un error; véase `error`.

Patrón de consulta periódica

            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"
          

Los trabajos se ejecutan de uno en uno por usuario, por lo que un run puede permanecer en Started mientras termina un trabajo anterior. Descargue el resultado con Files → Download a process result.

Ejemplo de respuesta

Respuesta de ejemplo

              {
              "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
              }
            

Errores

HTTP	Cuerpo / significado
401	`Unauthorized`
404	`Run not found`

Probar la API

Haga clic en el botón de abajo para probar este endpoint en directo en su navegador.

Atención: esta consola envía una solicitud real a su propio servidor desde su navegador, con su API token real.

Abrir consola

Consola de la API GET /api/Run/get

Dominio del servidor

Autenticación (HTTP Basic)

Email obligatorio

API token obligatorio

Parámetros

processId

kind

cURLJSPythonPHPNodeJavaC#Go

Runs & results

getRuns

Solicitud

Ejemplos de código

Parámetros

Respuesta

Valores de estado

Patrón de consulta periódica

Ejemplo de respuesta

Errores

Probar la API

Véase también

¿Fue útil este artículo?

Artículo anterior

Artículo siguiente