GET/v2/automationrule/executions

Automationsausführungen und Aktionsstatus lesen

Liest Ausführungshistorie des Kontos einschließlich Aktionsergebnissen. Filter nur trigger, rule und source_reference; status/search/filter werden ignoriert. Ohne source_reference entfällt der optionale subject-Snapshot meist aus Listen, mit gültiger Referenz wird Ereigniskontext geladen. Reihenfolge Ausführungs-ID absteigend. meta/limit enthalten Gesamtzahl und Seitengröße; meta.next_cursor liefert den before-Cursor. before überschreibt Offset und setzt ihn auf 0; total wird vor Cursorbegrenzung gezählt. Keine Wiederholung oder Ausführung von Aktionen. Regel-/Ausführungszeitstempel werden als ISO-8601-String oder null ausgegeben.

Operation-ID get_v2_automationrule_executions

Vertrag & Verhalten

Dokumentationsstand: reviewed
Ändert Zustand: Nein
Als readOnly markiert: Ja
Für Automation markiert: Ja

GET-Verhalten laut Spezifikation

read

Authentifizierung

Eine der folgenden Alternativen muss erfüllt sein (ODER). Innerhalb jeder Alternative werden alle angegebenen Schemas gemeinsam benötigt (UND).

Alternative 1

bearerAuthhttp · bearer

Existing edoobox v2 access token. Never substitute API key/secret headers.

Format: JWT

Security-Schema als JSON

{
  "type": "http",
  "scheme": "bearer",
  "bearerFormat": "JWT",
  "description": "Existing edoobox v2 access token. Never substitute API key/secret headers."
}

accountContextapiKey

Selected login/account context from the JWT, not a database primary key. Required even for a JWT with one account.

header: edid

Security-Schema als JSON

{
  "type": "apiKey",
  "in": "header",
  "name": "edid",
  "description": "Selected login/account context from the JWT, not a database primary key. Required even for a JWT with one account."
}

Alternative 2

sessionCookieapiKey

Existing browser login session, with the same permission checks as Bearer authentication.

cookie: _edlogin

Security-Schema als JSON

{
  "type": "apiKey",
  "in": "cookie",
  "name": "_edlogin",
  "description": "Existing browser login session, with the same permission checks as Bearer authentication."
}

accountContextapiKey

Selected login/account context from the JWT, not a database primary key. Required even for a JWT with one account.

header: edid

Security-Schema als JSON

{
  "type": "apiKey",
  "in": "header",
  "name": "edid",
  "description": "Selected login/account context from the JWT, not a database primary key. Required even for a JWT with one account."
}

Berechtigungen

Resource permission mapping from APIPermissions(), Authfunc::_getCheckJWT. Additional model/admin/plugin checks may apply; resources absent from api_permission do not acquire a fictitious scope.

Ressource: automationrule · auru
Levels: 1, 3, 4
Dispatcher-Prüfung: Ja

Parameter

Query-Parameter

limitoptional

JSON-Objekt start/reply oder Zahl als reply; Standard Offset 0, reply 100. Tatsächliche Seitengröße wird auf 1–200 begrenzt.

`application/json`

Typ nicht eingeschränkt

oneOf · Genau eine Variante muss passen

Variante 1 object

start integer

minimum: 0

Standardwert: 0

reply integer

minimum: 1
maximum: 200

Standardwert: 100

Zusätzliche, hier nicht aufgeführte Felder sind erlaubt.

Variante 2 integer

minimum: 1
maximum: 200

Vollständiges Schema als JSON

{
  "oneOf": [
    {
      "type": "object",
      "properties": {
        "start": {
          "type": "integer",
          "minimum": 0,
          "default": 0
        },
        "reply": {
          "type": "integer",
          "minimum": 1,
          "maximum": 200,
          "default": 100
        }
      },
      "additionalProperties": true
    },
    {
      "type": "integer",
      "minimum": 1,
      "maximum": 200
    }
  ]
}

Beispiel

{
  "start": 0,
  "reply": 25
}

triggeroptional

Auslöser; bestimmt verfügbare Kontextfelder und Aktionen.

string

Erlaubte Werte

"api.post.user""api.post.booking""api.post.offer""communication.booking_confirmation.before_send""communication.certificate.before_send"

Vollständiges Schema als JSON

{
  "type": "string",
  "enum": [
    "api.post.user",
    "api.post.booking",
    "api.post.offer",
    "communication.booking_confirmation.before_send",
    "communication.certificate.before_send"
  ]
}

source_referenceoptional

Öffentliche Ereignisreferenz (z.B. booking-/user-ID); nichtleere nicht rein numerische Referenz. Ungültige rein numerische Werte werden ignoriert.

string

Vollständiges Schema als JSON

{
  "type": "string"
}

beforeoptional

Nächste Seite vor dieser Ausführungs-ID. meta.next_cursor aus der vorherigen Seite verwenden; setzt Offset auf 0.

string

Öffentliche v2-ID aus dem aktuellen Konto.

pattern: "^automationexecution_[a-f0-9]{12}_-?[0-9]+$"

Vollständiges Schema als JSON

{
  "type": "string",
  "pattern": "^automationexecution_[a-f0-9]{12}_-?[0-9]+$",
  "description": "Öffentliche v2-ID aus dem aktuellen Konto."
}

ruleoptional

Ausführungen genau dieser Regel.

string

Öffentliche v2-ID aus dem aktuellen Konto.

pattern: "^automationrule_[a-f0-9]{12}_-?[0-9]+$"

Vollständiges Schema als JSON

{
  "type": "string",
  "pattern": "^automationrule_[a-f0-9]{12}_-?[0-9]+$",
  "description": "Öffentliche v2-ID aus dem aktuellen Konto."
}

Header

languageoptional

Account language code, where the resource supports setLanguage().

string

Schema-Beispiel

"de"

Vollständiges Schema als JSON

{
  "type": "string",
  "examples": [
    "de"
  ]
}

Request Body

Kein Request Body in der Spezifikation beschrieben.

Antworten

HTTP-Status und Antwortinhalt gemeinsam auswerten. In dieser API können auch Antworten mit HTTP 200 einen Fehler enthalten.

200application/json

data enthält das dokumentierte Ergebnisobjekt bzw. die Ergebnisliste; error=false und success=true.

`application/json`

object

success boolean

error boolean | string

error_code string

data array

Array-Elemente

object

id string erforderlich

Öffentliche v2-ID aus dem aktuellen Konto.

pattern: "^automationexecution_[a-f0-9]{12}_-?[0-9]+$"

event_id string erforderlich

Öffentliche v2-ID aus dem aktuellen Konto.

pattern: "^automationevent_[a-f0-9]{12}_-?[0-9]+$"

rule_id string erforderlich

Öffentliche v2-ID aus dem aktuellen Konto.

pattern: "^automationrule_[a-f0-9]{12}_-?[0-9]+$"

rule_name string erforderlich

trigger string erforderlich

status string erforderlich

Erlaubte Werte

"success""running""skipped""failed"

engine_status string erforderlich

matched boolean erforderlich

priority integer erforderlich

source_type string erforderlich

source_reference string | null erforderlich

correlation_id string erforderlich

duration_ms integer erforderlich

created_at string | null erforderlich

format: "date-time"

completed_at string | null erforderlich

format: "date-time"

has_error boolean erforderlich

subject object

participant_id string

Öffentliche v2-ID aus dem aktuellen Konto.

pattern: "^participant_[a-f0-9]{12}_-?[0-9]+$"

user_id string

Öffentliche v2-ID aus dem aktuellen Konto.

pattern: "^user_[a-f0-9]{12}_-?[0-9]+$"

name string

Zusätzliche, hier nicht aufgeführte Felder sind erlaubt.

actions array erforderlich

Array-Elemente

object

id string erforderlich

Öffentliche v2-ID aus dem aktuellen Konto.

pattern: "^automationactionexecution_[a-f0-9]{12}_-?[0-9]+$"

type string erforderlich

status string erforderlich

action object | array | null erforderlich

Gespeicherte Aktion. Bei user.update nur Feldnamen, keine neuen Feldwerte.

type string

fields array

Array-Elemente

string

Array-Elemente

Typ nicht eingeschränkt

Zusätzliche, hier nicht aufgeführte Felder sind erlaubt.

result object | array | null erforderlich

Aktionsspezifisch; sensible Schlüssel redigiert und rohe *_id-Werte entfernt.

Array-Elemente

Typ nicht eingeschränkt

Zusätzliche, hier nicht aufgeführte Felder sind erlaubt.

template object | null erforderlich

id string

Öffentliche v2-ID aus dem aktuellen Konto.

pattern: "^et_[a-f0-9]{12}_-?[0-9]+$"

name string

type string

preview_available boolean

file_name string

Zusätzliche, hier nicht aufgeführte Felder sind erlaubt.

attempts integer erforderlich

available_at string | null erforderlich

format: "date-time"

started_at string | null erforderlich

format: "date-time"

completed_at string | null erforderlich

format: "date-time"

duration_ms integer erforderlich

has_error boolean erforderlich

error_message string | null erforderlich

Zusätzliche, hier nicht aufgeführte Felder sind erlaubt.

type string

Zusätzliche, hier nicht aufgeführte Felder sind erlaubt.

Vollständiges Schema als JSON

{
  "type": "object",
  "properties": {
    "success": {
      "type": "boolean"
    },
    "error": {
      "type": [
        "boolean",
        "string"
      ]
    },
    "error_code": {
      "type": "string"
    },
    "data": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "pattern": "^automationexecution_[a-f0-9]{12}_-?[0-9]+$",
            "description": "Öffentliche v2-ID aus dem aktuellen Konto."
          },
          "event_id": {
            "type": "string",
            "pattern": "^automationevent_[a-f0-9]{12}_-?[0-9]+$",
            "description": "Öffentliche v2-ID aus dem aktuellen Konto."
          },
          "rule_id": {
            "type": "string",
            "pattern": "^automationrule_[a-f0-9]{12}_-?[0-9]+$",
            "description": "Öffentliche v2-ID aus dem aktuellen Konto."
          },
          "rule_name": {
            "type": "string"
          },
          "trigger": {
            "type": "string"
          },
          "status": {
            "type": "string",
            "enum": [
              "success",
              "running",
              "skipped",
              "failed"
            ]
          },
          "engine_status": {
            "type": "string"
          },
          "matched": {
            "type": "boolean"
          },
          "priority": {
            "type": "integer"
          },
          "source_type": {
            "type": "string"
          },
          "source_reference": {
            "type": [
              "string",
              "null"
            ]
          },
          "correlation_id": {
            "type": "string"
          },
          "duration_ms": {
            "type": "integer"
          },
          "created_at": {
            "type": [
              "string",
              "null"
            ],
            "format": "date-time"
          },
          "completed_at": {
            "type": [
              "string",
              "null"
            ],
            "format": "date-time"
          },
          "has_error": {
            "type": "boolean"
          },
          "subject": {
            "type": "object",
            "properties": {
              "participant_id": {
                "type": "string",
                "pattern": "^participant_[a-f0-9]{12}_-?[0-9]+$",
                "description": "Öffentliche v2-ID aus dem aktuellen Konto."
              },
              "user_id": {
                "type": "string",
                "pattern": "^user_[a-f0-9]{12}_-?[0-9]+$",
                "description": "Öffentliche v2-ID aus dem aktuellen Konto."
              },
              "name": {
                "type": "string"
              }
            },
            "additionalProperties": true
          },
          "actions": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "id": {
                  "type": "string",
                  "pattern": "^automationactionexecution_[a-f0-9]{12}_-?[0-9]+$",
                  "description": "Öffentliche v2-ID aus dem aktuellen Konto."
                },
                "type": {
                  "type": "string"
                },
                "status": {
                  "type": "string"
                },
                "action": {
                  "type": [
                    "object",
                    "array",
                    "null"
                  ],
                  "properties": {
                    "type": {
                      "type": "string"
                    },
                    "fields": {
                      "type": "array",
                      "items": {
                        "type": "string"
                      }
                    }
                  },
                  "additionalProperties": true,
                  "items": {},
                  "description": "Gespeicherte Aktion. Bei user.update nur Feldnamen, keine neuen Feldwerte."
                },
                "result": {
                  "type": [
                    "object",
                    "array",
                    "null"
                  ],
                  "additionalProperties": true,
                  "items": {},
                  "description": "Aktionsspezifisch; sensible Schlüssel redigiert und rohe *_id-Werte entfernt."
                },
                "template": {
                  "type": [
                    "object",
                    "null"
                  ],
                  "properties": {
                    "id": {
                      "type": "string",
                      "pattern": "^et_[a-f0-9]{12}_-?[0-9]+$",
                      "description": "Öffentliche v2-ID aus dem aktuellen Konto."
                    },
                    "name": {
                      "type": "string"
                    },
                    "type": {
                      "type": "string"
                    },
                    "preview_available": {
                      "type": "boolean"
                    },
                    "file_name": {
                      "type": "string"
                    }
                  },
                  "additionalProperties": true
                },
                "attempts": {
                  "type": "integer"
                },
                "available_at": {
                  "type": [
                    "string",
                    "null"
                  ],
                  "format": "date-time"
                },
                "started_at": {
                  "type": [
                    "string",
                    "null"
                  ],
                  "format": "date-time"
                },
                "completed_at": {
                  "type": [
                    "string",
                    "null"
                  ],
                  "format": "date-time"
                },
                "duration_ms": {
                  "type": "integer"
                },
                "has_error": {
                  "type": "boolean"
                },
                "error_message": {
                  "type": [
                    "string",
                    "null"
                  ]
                }
              },
              "additionalProperties": true,
              "required": [
                "id",
                "type",
                "status",
                "action",
                "result",
                "template",
                "attempts",
                "available_at",
                "started_at",
                "completed_at",
                "duration_ms",
                "has_error",
                "error_message"
              ]
            }
          }
        },
        "additionalProperties": true,
        "required": [
          "id",
          "event_id",
          "rule_id",
          "rule_name",
          "trigger",
          "status",
          "engine_status",
          "matched",
          "priority",
          "source_type",
          "source_reference",
          "correlation_id",
          "duration_ms",
          "created_at",
          "completed_at",
          "has_error",
          "actions"
        ]
      }
    },
    "type": {
      "type": "string"
    }
  },
  "additionalProperties": true
}

Beispiel

{
  "success": true,
  "error": false,
  "data": [
    {
      "id": "automationexecution_012345abcdef_123456",
      "event_id": "automationevent_012345abcdef_123456",
      "rule_id": "automationrule_012345abcdef_123456",
      "rule_name": "Neue Kunden begrüßen",
      "trigger": "api.post.user",
      "status": "skipped",
      "engine_status": "not_matched",
      "matched": false,
      "priority": 100,
      "source_type": "user",
      "source_reference": "user_012345abcdef_123456",
      "correlation_id": "synthetic-correlation-001",
      "duration_ms": 0,
      "created_at": "2026-10-22T10:00:00+02:00",
      "completed_at": "2026-10-22T10:00:00+02:00",
      "has_error": false,
      "actions": []
    }
  ]
}

400application/json

Invalid request.

`application/json`

Typ nicht eingeschränkt

Kein Schema angegeben. Daraus lässt sich kein vollständiger Feldvertrag ableiten.

Beispiel

{
  "success": false,
  "error": "ED40006"
}

401application/json

Missing/expired token, missing account context, account paused or model-specific authorization failure.

`application/json`

Typ nicht eingeschränkt

Kein Schema angegeben. Daraus lässt sich kein vollständiger Feldvertrag ableiten.

Beispiel

{
  "success": false,
  "error": "ED40103"
}

402application/json

Missing/invalid action data or subscription/operation restriction.

`application/json`

Typ nicht eingeschränkt

Kein Schema angegeben. Daraus lässt sich kein vollständiger Feldvertrag ableiten.

Beispiel

{
  "success": false,
  "error": "ED80100"
}

403application/json

Permission denied. Browser CORS rejection may have an empty body.

`application/json`

Typ nicht eingeschränkt

Kein Schema angegeben. Daraus lässt sich kein vollständiger Feldvertrag ableiten.

Beispiel

{
  "success": false,
  "error": "ED40340"
}

404application/json

Unknown resource/action or unsupported method.

`application/json`

Typ nicht eingeschränkt

Kein Schema angegeben. Daraus lässt sich kein vollständiger Feldvertrag ableiten.

Beispiel

{
  "success": false,
  "error": "ED80019"
}

422application/json

Validation failed.

`application/json`

Typ nicht eingeschränkt

Kein Schema angegeben. Daraus lässt sich kein vollständiger Feldvertrag ableiten.

Beispiel

{
  "success": false,
  "error": "ED80020"
}

429application/json

Request/login rate limit exceeded. Honor Retry-After when supplied; legacy rate-limit paths may omit it. Retry only proven reads within a bounded deadline; a mutation is never automatically replayed after an ambiguous response.

Response Header

`Retry-After`

Optional server delay in whole seconds or an HTTP date. Absence is not permission for an immediate retry.

string

Schema-Beispiel

"30"

Vollständiges Schema als JSON

{
  "type": "string",
  "examples": [
    "30"
  ]
}

`application/json`

Typ nicht eingeschränkt

Kein Schema angegeben. Daraus lässt sich kein vollständiger Feldvertrag ableiten.

Beispiel

{
  "success": false,
  "error": "ED42902"
}

502application/json

Server-side operation failed.

`application/json`

Typ nicht eingeschränkt

Kein Schema angegeben. Daraus lässt sich kein vollständiger Feldvertrag ableiten.

Beispiel

{
  "success": false,
  "error": "ED50201"
}

Quelle & Metadaten

Quelle laut Spezifikationapplication/models/v2/Automationrule.php:38getAutomationrule()

Diese Angaben stammen unverändert aus der gelieferten OpenAPI-Datei. Zusätzliche Freigaben, Vorbedingungen, sensible Felder und Hinweise stehen in den Erweiterungen.

x-edoobox-mutates-state

false

x-edoobox-mutationReview

{
  "source": {
    "file": "application/models/v2/Automationrule.php",
    "line": 38
  },
  "reason": "Read rules, existing execution history or static catalog/samples; no execution is started."
}

x-edoobox-runtimeMutationGuard

false

x-edoobox-get-effect

"read"

x-edoobox-documentationReview

{
  "file": "docs/openapi/operation-contracts/01-membership.json",
  "notes": []
}

x-edoobox-source

{
  "file": "application/models/v2/Automationrule.php",
  "method": "getAutomationrule",
  "line": 38,
  "branch": {
    "file": "application/models/v2/Automationrule.php",
    "line": 49
  }
}

x-edoobox-documentationStatus

"reviewed"

x-edoobox-readOnly

true

x-edoobox-safeForAutomation

true

x-edoobox-permission

{
  "resource": "automationrule",
  "short": "auru",
  "checkedByDispatcher": true,
  "levels": [
    1,
    3,
    4
  ],
  "description": "Resource permission mapping from APIPermissions(), Authfunc::_getCheckJWT. Additional model/admin/plugin checks may apply; resources absent from api_permission do not acquire a fictitious scope."
}

Vollständige Operation als JSON

{
  "operationId": "get_v2_automationrule_executions",
  "summary": "Automationsausführungen und Aktionsstatus lesen",
  "description": "Liest Ausführungshistorie des Kontos einschließlich Aktionsergebnissen. Filter nur trigger, rule und source_reference; status/search/filter werden ignoriert. Ohne source_reference entfällt der optionale subject-Snapshot meist aus Listen, mit gültiger Referenz wird Ereigniskontext geladen. Reihenfolge Ausführungs-ID absteigend. meta/limit enthalten Gesamtzahl und Seitengröße; meta.next_cursor liefert den before-Cursor. before überschreibt Offset und setzt ihn auf 0; total wird vor Cursorbegrenzung gezählt. Keine Wiederholung oder Ausführung von Aktionen. Regel-/Ausführungszeitstempel werden als ISO-8601-String oder null ausgegeben.",
  "tags": [
    "automationrule"
  ],
  "security": [
    {
      "bearerAuth": [],
      "accountContext": []
    },
    {
      "sessionCookie": [],
      "accountContext": []
    }
  ],
  "parameters": [
    {
      "name": "limit",
      "in": "query",
      "required": false,
      "description": "JSON-Objekt start/reply oder Zahl als reply; Standard Offset 0, reply 100. Tatsächliche Seitengröße wird auf 1–200 begrenzt.",
      "content": {
        "application/json": {
          "schema": {
            "oneOf": [
              {
                "type": "object",
                "properties": {
                  "start": {
                    "type": "integer",
                    "minimum": 0,
                    "default": 0
                  },
                  "reply": {
                    "type": "integer",
                    "minimum": 1,
                    "maximum": 200,
                    "default": 100
                  }
                },
                "additionalProperties": true
              },
              {
                "type": "integer",
                "minimum": 1,
                "maximum": 200
              }
            ]
          },
          "example": {
            "start": 0,
            "reply": 25
          }
        }
      }
    },
    {
      "name": "trigger",
      "in": "query",
      "required": false,
      "description": "Auslöser; bestimmt verfügbare Kontextfelder und Aktionen.",
      "schema": {
        "type": "string",
        "enum": [
          "api.post.user",
          "api.post.booking",
          "api.post.offer",
          "communication.booking_confirmation.before_send",
          "communication.certificate.before_send"
        ]
      }
    },
    {
      "name": "source_reference",
      "in": "query",
      "required": false,
      "description": "Öffentliche Ereignisreferenz (z.B. booking-/user-ID); nichtleere nicht rein numerische Referenz. Ungültige rein numerische Werte werden ignoriert.",
      "schema": {
        "type": "string"
      }
    },
    {
      "name": "before",
      "in": "query",
      "required": false,
      "description": "Nächste Seite vor dieser Ausführungs-ID. meta.next_cursor aus der vorherigen Seite verwenden; setzt Offset auf 0.",
      "schema": {
        "type": "string",
        "pattern": "^automationexecution_[a-f0-9]{12}_-?[0-9]+$",
        "description": "Öffentliche v2-ID aus dem aktuellen Konto."
      }
    },
    {
      "name": "rule",
      "in": "query",
      "required": false,
      "description": "Ausführungen genau dieser Regel.",
      "schema": {
        "type": "string",
        "pattern": "^automationrule_[a-f0-9]{12}_-?[0-9]+$",
        "description": "Öffentliche v2-ID aus dem aktuellen Konto."
      }
    },
    {
      "name": "language",
      "in": "header",
      "required": false,
      "description": "Account language code, where the resource supports setLanguage().",
      "schema": {
        "type": "string",
        "examples": [
          "de"
        ]
      }
    }
  ],
  "responses": {
    "200": {
      "description": "data enthält das dokumentierte Ergebnisobjekt bzw. die Ergebnisliste; error=false und success=true.",
      "content": {
        "application/json": {
          "example": {
            "success": true,
            "error": false,
            "data": [
              {
                "id": "automationexecution_012345abcdef_123456",
                "event_id": "automationevent_012345abcdef_123456",
                "rule_id": "automationrule_012345abcdef_123456",
                "rule_name": "Neue Kunden begrüßen",
                "trigger": "api.post.user",
                "status": "skipped",
                "engine_status": "not_matched",
                "matched": false,
                "priority": 100,
                "source_type": "user",
                "source_reference": "user_012345abcdef_123456",
                "correlation_id": "synthetic-correlation-001",
                "duration_ms": 0,
                "created_at": "2026-10-22T10:00:00+02:00",
                "completed_at": "2026-10-22T10:00:00+02:00",
                "has_error": false,
                "actions": []
              }
            ]
          },
          "schema": {
            "type": "object",
            "properties": {
              "success": {
                "type": "boolean"
              },
              "error": {
                "type": [
                  "boolean",
                  "string"
                ]
              },
              "error_code": {
                "type": "string"
              },
              "data": {
                "type": "array",
                "items": {
                  "type": "object",
                  "properties": {
                    "id": {
                      "type": "string",
                      "pattern": "^automationexecution_[a-f0-9]{12}_-?[0-9]+$",
                      "description": "Öffentliche v2-ID aus dem aktuellen Konto."
                    },
                    "event_id": {
                      "type": "string",
                      "pattern": "^automationevent_[a-f0-9]{12}_-?[0-9]+$",
                      "description": "Öffentliche v2-ID aus dem aktuellen Konto."
                    },
                    "rule_id": {
                      "type": "string",
                      "pattern": "^automationrule_[a-f0-9]{12}_-?[0-9]+$",
                      "description": "Öffentliche v2-ID aus dem aktuellen Konto."
                    },
                    "rule_name": {
                      "type": "string"
                    },
                    "trigger": {
                      "type": "string"
                    },
                    "status": {
                      "type": "string",
                      "enum": [
                        "success",
                        "running",
                        "skipped",
                        "failed"
                      ]
                    },
                    "engine_status": {
                      "type": "string"
                    },
                    "matched": {
                      "type": "boolean"
                    },
                    "priority": {
                      "type": "integer"
                    },
                    "source_type": {
                      "type": "string"
                    },
                    "source_reference": {
                      "type": [
                        "string",
                        "null"
                      ]
                    },
                    "correlation_id": {
                      "type": "string"
                    },
                    "duration_ms": {
                      "type": "integer"
                    },
                    "created_at": {
                      "type": [
                        "string",
                        "null"
                      ],
                      "format": "date-time"
                    },
                    "completed_at": {
                      "type": [
                        "string",
                        "null"
                      ],
                      "format": "date-time"
                    },
                    "has_error": {
                      "type": "boolean"
                    },
                    "subject": {
                      "type": "object",
                      "properties": {
                        "participant_id": {
                          "type": "string",
                          "pattern": "^participant_[a-f0-9]{12}_-?[0-9]+$",
                          "description": "Öffentliche v2-ID aus dem aktuellen Konto."
                        },
                        "user_id": {
                          "type": "string",
                          "pattern": "^user_[a-f0-9]{12}_-?[0-9]+$",
                          "description": "Öffentliche v2-ID aus dem aktuellen Konto."
                        },
                        "name": {
                          "type": "string"
                        }
                      },
                      "additionalProperties": true
                    },
                    "actions": {
                      "type": "array",
                      "items": {
                        "type": "object",
                        "properties": {
                          "id": {
                            "type": "string",
                            "pattern": "^automationactionexecution_[a-f0-9]{12}_-?[0-9]+$",
                            "description": "Öffentliche v2-ID aus dem aktuellen Konto."
                          },
                          "type": {
                            "type": "string"
                          },
                          "status": {
                            "type": "string"
                          },
                          "action": {
                            "type": [
                              "object",
                              "array",
                              "null"
                            ],
                            "properties": {
                              "type": {
                                "type": "string"
                              },
                              "fields": {
                                "type": "array",
                                "items": {
                                  "type": "string"
                                }
                              }
                            },
                            "additionalProperties": true,
                            "items": {},
                            "description": "Gespeicherte Aktion. Bei user.update nur Feldnamen, keine neuen Feldwerte."
                          },
                          "result": {
                            "type": [
                              "object",
                              "array",
                              "null"
                            ],
                            "additionalProperties": true,
                            "items": {},
                            "description": "Aktionsspezifisch; sensible Schlüssel redigiert und rohe *_id-Werte entfernt."
                          },
                          "template": {
                            "type": [
                              "object",
                              "null"
                            ],
                            "properties": {
                              "id": {
                                "type": "string",
                                "pattern": "^et_[a-f0-9]{12}_-?[0-9]+$",
                                "description": "Öffentliche v2-ID aus dem aktuellen Konto."
                              },
                              "name": {
                                "type": "string"
                              },
                              "type": {
                                "type": "string"
                              },
                              "preview_available": {
                                "type": "boolean"
                              },
                              "file_name": {
                                "type": "string"
                              }
                            },
                            "additionalProperties": true
                          },
                          "attempts": {
                            "type": "integer"
                          },
                          "available_at": {
                            "type": [
                              "string",
                              "null"
                            ],
                            "format": "date-time"
                          },
                          "started_at": {
                            "type": [
                              "string",
                              "null"
                            ],
                            "format": "date-time"
                          },
                          "completed_at": {
                            "type": [
                              "string",
                              "null"
                            ],
                            "format": "date-time"
                          },
                          "duration_ms": {
                            "type": "integer"
                          },
                          "has_error": {
                            "type": "boolean"
                          },
                          "error_message": {
                            "type": [
                              "string",
                              "null"
                            ]
                          }
                        },
                        "additionalProperties": true,
                        "required": [
                          "id",
                          "type",
                          "status",
                          "action",
                          "result",
                          "template",
                          "attempts",
                          "available_at",
                          "started_at",
                          "completed_at",
                          "duration_ms",
                          "has_error",
                          "error_message"
                        ]
                      }
                    }
                  },
                  "additionalProperties": true,
                  "required": [
                    "id",
                    "event_id",
                    "rule_id",
                    "rule_name",
                    "trigger",
                    "status",
                    "engine_status",
                    "matched",
                    "priority",
                    "source_type",
                    "source_reference",
                    "correlation_id",
                    "duration_ms",
                    "created_at",
                    "completed_at",
                    "has_error",
                    "actions"
                  ]
                }
              },
              "type": {
                "type": "string"
              }
            },
            "additionalProperties": true
          }
        }
      }
    },
    "400": {
      "description": "Invalid request.",
      "content": {
        "application/json": {
          "example": {
            "success": false,
            "error": "ED40006"
          }
        }
      }
    },
    "401": {
      "description": "Missing/expired token, missing account context, account paused or model-specific authorization failure.",
      "content": {
        "application/json": {
          "example": {
            "success": false,
            "error": "ED40103"
          }
        }
      }
    },
    "402": {
      "description": "Missing/invalid action data or subscription/operation restriction.",
      "content": {
        "application/json": {
          "example": {
            "success": false,
            "error": "ED80100"
          }
        }
      }
    },
    "403": {
      "description": "Permission denied. Browser CORS rejection may have an empty body.",
      "content": {
        "application/json": {
          "example": {
            "success": false,
            "error": "ED40340"
          }
        }
      }
    },
    "404": {
      "description": "Unknown resource/action or unsupported method.",
      "content": {
        "application/json": {
          "example": {
            "success": false,
            "error": "ED80019"
          }
        }
      }
    },
    "422": {
      "description": "Validation failed.",
      "content": {
        "application/json": {
          "example": {
            "success": false,
            "error": "ED80020"
          }
        }
      }
    },
    "429": {
      "description": "Request/login rate limit exceeded. Honor Retry-After when supplied; legacy rate-limit paths may omit it. Retry only proven reads within a bounded deadline; a mutation is never automatically replayed after an ambiguous response.",
      "content": {
        "application/json": {
          "example": {
            "success": false,
            "error": "ED42902"
          }
        }
      },
      "headers": {
        "Retry-After": {
          "description": "Optional server delay in whole seconds or an HTTP date. Absence is not permission for an immediate retry.",
          "schema": {
            "type": "string",
            "examples": [
              "30"
            ]
          }
        }
      }
    },
    "502": {
      "description": "Server-side operation failed.",
      "content": {
        "application/json": {
          "example": {
            "success": false,
            "error": "ED50201"
          }
        }
      }
    }
  },
  "x-edoobox-mutates-state": false,
  "x-edoobox-mutationReview": {
    "source": {
      "file": "application/models/v2/Automationrule.php",
      "line": 38
    },
    "reason": "Read rules, existing execution history or static catalog/samples; no execution is started."
  },
  "x-edoobox-runtimeMutationGuard": false,
  "x-edoobox-get-effect": "read",
  "x-edoobox-documentationReview": {
    "file": "docs/openapi/operation-contracts/01-membership.json",
    "notes": []
  },
  "x-edoobox-source": {
    "file": "application/models/v2/Automationrule.php",
    "method": "getAutomationrule",
    "line": 38,
    "branch": {
      "file": "application/models/v2/Automationrule.php",
      "line": 49
    }
  },
  "x-edoobox-documentationStatus": "reviewed",
  "x-edoobox-readOnly": true,
  "x-edoobox-safeForAutomation": true,
  "x-edoobox-permission": {
    "resource": "automationrule",
    "short": "auru",
    "checkedByDispatcher": true,
    "levels": [
      1,
      3,
      4
    ],
    "description": "Resource permission mapping from APIPermissions(), Authfunc::_getCheckJWT. Additional model/admin/plugin checks may apply; resources absent from api_permission do not acquire a fictitious scope."
  }
}

Aufruf vorbereiten

Beispiel

Platzhalter ersetzen und Vertragsangaben prüfen. Die Beispiele werden hier nicht ausgeführt.

cURL

# Zeigt Authentifizierungsalternative 1; alle Verfahren dieser Alternative sind gemeinsam erforderlich.
: "${API_ORIGIN:?API_ORIGIN setzen}"
: "${AUTH_BEARERAUTH:?AUTH_BEARERAUTH setzen}"
: "${AUTH_ACCOUNTCONTEXT:?AUTH_ACCOUNTCONTEXT setzen}"
curl --request 'GET' \
  --url "${API_ORIGIN%/}"'/v2/automationrule/executions' \
  --header 'Authorization: Bearer '"${AUTH_BEARERAUTH}" \
  --header 'edid: '"${AUTH_ACCOUNTCONTEXT}"

JavaScript

// Zeigt Authentifizierungsalternative 1; alle Verfahren dieser Alternative sind gemeinsam erforderlich.
const required = (name) => {
  const value = process.env[name];
  if (!value) throw new Error(`Set ${name}`);
  return value;
};
let path = "/v2/automationrule/executions";
const origin = required('API_ORIGIN');
const url = new URL((origin.endsWith('/') ? origin.slice(0, -1) : origin) + path);
const headers = {};
headers["Authorization"] = "Bearer " + required("AUTH_BEARERAUTH");
headers["edid"] = "" + required("AUTH_ACCOUNTCONTEXT");
const response = await fetch(url, { method: "GET", headers, redirect: 'manual' });
const text = await response.text();
console.log(response.status, text);
// HTTP-Status und dokumentierte error/success-Felder gemeinsam prüfen.

Python

# Zeigt Authentifizierungsalternative 1; alle Verfahren dieser Alternative sind gemeinsam erforderlich.
import os
import urllib.parse
import urllib.request
import urllib.error

path = "/v2/automationrule/executions"
url = os.environ["API_ORIGIN"].rstrip("/") + path
headers = {}
headers["Authorization"] = "Bearer " + os.environ["AUTH_BEARERAUTH"]
headers["edid"] = "" + os.environ["AUTH_ACCOUNTCONTEXT"]

# Redirects nicht automatisch verfolgen.
class NoRedirect(urllib.request.HTTPRedirectHandler):
    def redirect_request(self, req, fp, code, msg, headers, newurl):
        return None
request = urllib.request.Request(url, headers=headers, method="GET")
try:
    response = urllib.request.build_opener(NoRedirect).open(request, timeout=30)
except urllib.error.HTTPError as error:
    response = error
print(response.status, response.read().decode("utf-8", errors="replace"))
# HTTP-Status und dokumentierte error/success-Felder gemeinsam prüfen.

Ohne JavaScript können Sie die weiteren Aufrufbeispiele hier aufklappen und den Code manuell kopieren.

JavaScript

// Zeigt Authentifizierungsalternative 1; alle Verfahren dieser Alternative sind gemeinsam erforderlich.
const required = (name) => {
  const value = process.env[name];
  if (!value) throw new Error(`Set ${name}`);
  return value;
};
let path = "/v2/automationrule/executions";
const origin = required('API_ORIGIN');
const url = new URL((origin.endsWith('/') ? origin.slice(0, -1) : origin) + path);
const headers = {};
headers["Authorization"] = "Bearer " + required("AUTH_BEARERAUTH");
headers["edid"] = "" + required("AUTH_ACCOUNTCONTEXT");
const response = await fetch(url, { method: "GET", headers, redirect: 'manual' });
const text = await response.text();
console.log(response.status, text);
// HTTP-Status und dokumentierte error/success-Felder gemeinsam prüfen.

Python

# Zeigt Authentifizierungsalternative 1; alle Verfahren dieser Alternative sind gemeinsam erforderlich.
import os
import urllib.parse
import urllib.request
import urllib.error

path = "/v2/automationrule/executions"
url = os.environ["API_ORIGIN"].rstrip("/") + path
headers = {}
headers["Authorization"] = "Bearer " + os.environ["AUTH_BEARERAUTH"]
headers["edid"] = "" + os.environ["AUTH_ACCOUNTCONTEXT"]

# Redirects nicht automatisch verfolgen.
class NoRedirect(urllib.request.HTTPRedirectHandler):
    def redirect_request(self, req, fp, code, msg, headers, newurl):
        return None
request = urllib.request.Request(url, headers=headers, method="GET")
try:
    response = urllib.request.build_opener(NoRedirect).open(request, timeout=30)
except urllib.error.HTTPError as error:
    response = error
print(response.status, response.read().decode("utf-8", errors="replace"))
# HTTP-Status und dokumentierte error/success-Felder gemeinsam prüfen.

Server aus der Spezifikation

https://app2.edoobox.com

edoobox API

Verwenden Sie die für Ihre Integration bestätigte API-Basis-URL. Ein lokaler Entwicklungsserver ist keine Produktionsadresse.

Als Markdown lesenEin Endpunkt. Vollständig. Für Menschen und LLM.