Zum Inhalt
edoobox Docs
Kostenlos testen 7 Tage unverbindlich testen
Menü
Kostenlos testen 7 Tage unverbindlich testen
OpenAPI herunterladen
automationruleAPI-Referenz
GET/v2/automationrule/samples

Kontoobjekte für eine Regelsimulation suchen

Sucht existierende Kontoobjekte passend zum obligatorischen trigger. api.post.user nutzt Benutzer, api.post.booking und booking_confirmation Buchungen, api.post.offer Angebote, certificate Teilnehmer. Liefert öffentliche Auswahl-IDs, Anzeigenamen und Untertitel einschließlich möglicher personenbezogener Inhalte; keine Aktion oder Ausführung wird erzeugt. search wird auf 100 Zeichen begrenzt; keine Offset-Pagination oder Gesamtzahl. Regel-/Ausführungszeitstempel werden als ISO-8601-String oder null ausgegeben.

Operation-ID get_v2_automationrule_samples

01

Vertrag & Verhalten

Dokumentationsstand
reviewed
Ändert Zustand
Nein
Als readOnly markiert
Ja
Für Automation markiert
Ja
GET-Verhalten laut Spezifikation

read

02

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.

03

Parameter

Query-Parameter

limitoptional

Nur reply wird verwendet; start/Offset wird ignoriert. Dispatcherstandard 100 wird auf 50 reduziert; explizite positive Werte auf 1–50 begrenzt, Werte unter 1 führen zum Servicefallback 20.

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
50

Standardwert: 50

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

Variante 2 integer
minimum
1
maximum
50
Vollständiges Schema als JSON
{
  "oneOf": [
    {
      "type": "object",
      "properties": {
        "start": {
          "type": "integer",
          "minimum": 0,
          "default": 0
        },
        "reply": {
          "type": "integer",
          "minimum": 1,
          "maximum": 50,
          "default": 50
        }
      },
      "additionalProperties": true
    },
    {
      "type": "integer",
      "minimum": 1,
      "maximum": 50
    }
  ]
}
Beispiel
{
  "start": 0,
  "reply": 25
}
triggererforderlich

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"
  ]
}
searchoptional

Suche in den zum Trigger passenden Kontoobjekten; maximal 100 Zeichen werden benutzt.

string
Vollständiges Schema als JSON
{
  "type": "string"
}

Header

languageoptional

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

string
Schema-Beispiel
"de"
Vollständiges Schema als JSON
{
  "type": "string",
  "examples": [
    "de"
  ]
}
04

Request Body

Kein Request Body in der Spezifikation beschrieben.

05

Antworten

9

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 object
items array erforderlich
Array-Elemente
object
id string erforderlich

Öffentliche ID eines Kontoobjekts passend zum Trigger: api.post.user→user, api.post.booking/booking_confirmation→booking, api.post.offer→offer, certificate→participant. Kein künstliches Ereignis wird gespeichert.

pattern
"^(?:user|booking|offer|participant)_[a-f0-9]{12}_-?[0-9]+$"
name string erforderlich
subtitle string erforderlich
resource_type string erforderlich
Erlaubte Werte
"user""booking""offer""participant"

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

resource_type string erforderlich
Erlaubte Werte
"user""booking""offer""participant"

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": "object",
      "properties": {
        "items": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "id": {
                "type": "string",
                "pattern": "^(?:user|booking|offer|participant)_[a-f0-9]{12}_-?[0-9]+$",
                "description": "Öffentliche ID eines Kontoobjekts passend zum Trigger: api.post.user→user, api.post.booking/booking_confirmation→booking, api.post.offer→offer, certificate→participant. Kein künstliches Ereignis wird gespeichert."
              },
              "name": {
                "type": "string"
              },
              "subtitle": {
                "type": "string"
              },
              "resource_type": {
                "type": "string",
                "enum": [
                  "user",
                  "booking",
                  "offer",
                  "participant"
                ]
              }
            },
            "additionalProperties": true,
            "required": [
              "id",
              "name",
              "subtitle",
              "resource_type"
            ]
          }
        },
        "resource_type": {
          "type": "string",
          "enum": [
            "user",
            "booking",
            "offer",
            "participant"
          ]
        }
      },
      "additionalProperties": true,
      "required": [
        "items",
        "resource_type"
      ]
    },
    "type": {
      "type": "string"
    }
  },
  "additionalProperties": true
}
Beispiel
{
  "success": true,
  "error": false,
  "data": {
    "items": [
      {
        "id": "user_012345abcdef_123456",
        "name": "Alex Beispiel",
        "subtitle": "alex@example.com",
        "resource_type": "user"
      }
    ],
    "resource_type": "user"
  }
}
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"
}
06

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": 46
  }
}
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_samples",
  "summary": "Kontoobjekte für eine Regelsimulation suchen",
  "description": "Sucht existierende Kontoobjekte passend zum obligatorischen trigger. api.post.user nutzt Benutzer, api.post.booking und booking_confirmation Buchungen, api.post.offer Angebote, certificate Teilnehmer. Liefert öffentliche Auswahl-IDs, Anzeigenamen und Untertitel einschließlich möglicher personenbezogener Inhalte; keine Aktion oder Ausführung wird erzeugt. search wird auf 100 Zeichen begrenzt; keine Offset-Pagination oder Gesamtzahl. 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": "Nur reply wird verwendet; start/Offset wird ignoriert. Dispatcherstandard 100 wird auf 50 reduziert; explizite positive Werte auf 1–50 begrenzt, Werte unter 1 führen zum Servicefallback 20.",
      "content": {
        "application/json": {
          "schema": {
            "oneOf": [
              {
                "type": "object",
                "properties": {
                  "start": {
                    "type": "integer",
                    "minimum": 0,
                    "default": 0
                  },
                  "reply": {
                    "type": "integer",
                    "minimum": 1,
                    "maximum": 50,
                    "default": 50
                  }
                },
                "additionalProperties": true
              },
              {
                "type": "integer",
                "minimum": 1,
                "maximum": 50
              }
            ]
          },
          "example": {
            "start": 0,
            "reply": 25
          }
        }
      }
    },
    {
      "name": "trigger",
      "in": "query",
      "required": true,
      "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": "search",
      "in": "query",
      "required": false,
      "description": "Suche in den zum Trigger passenden Kontoobjekten; maximal 100 Zeichen werden benutzt.",
      "schema": {
        "type": "string"
      }
    },
    {
      "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": {
              "items": [
                {
                  "id": "user_012345abcdef_123456",
                  "name": "Alex Beispiel",
                  "subtitle": "alex@example.com",
                  "resource_type": "user"
                }
              ],
              "resource_type": "user"
            }
          },
          "schema": {
            "type": "object",
            "properties": {
              "success": {
                "type": "boolean"
              },
              "error": {
                "type": [
                  "boolean",
                  "string"
                ]
              },
              "error_code": {
                "type": "string"
              },
              "data": {
                "type": "object",
                "properties": {
                  "items": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "properties": {
                        "id": {
                          "type": "string",
                          "pattern": "^(?:user|booking|offer|participant)_[a-f0-9]{12}_-?[0-9]+$",
                          "description": "Öffentliche ID eines Kontoobjekts passend zum Trigger: api.post.user→user, api.post.booking/booking_confirmation→booking, api.post.offer→offer, certificate→participant. Kein künstliches Ereignis wird gespeichert."
                        },
                        "name": {
                          "type": "string"
                        },
                        "subtitle": {
                          "type": "string"
                        },
                        "resource_type": {
                          "type": "string",
                          "enum": [
                            "user",
                            "booking",
                            "offer",
                            "participant"
                          ]
                        }
                      },
                      "additionalProperties": true,
                      "required": [
                        "id",
                        "name",
                        "subtitle",
                        "resource_type"
                      ]
                    }
                  },
                  "resource_type": {
                    "type": "string",
                    "enum": [
                      "user",
                      "booking",
                      "offer",
                      "participant"
                    ]
                  }
                },
                "additionalProperties": true,
                "required": [
                  "items",
                  "resource_type"
                ]
              },
              "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": 46
    }
  },
  "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."
  }
}