Zum Inhalt
edoobox Docs

Suchen Sie nach einer Aufgabe oder einem Thema, z. B. Rechnung oder Warteliste.
Kostenlos testen 7 Tage unverbindlich testen
Menü
Kostenlos testen 7 Tage unverbindlich testen
OpenAPI herunterladen
exportmanagerAPI-Referenz
POST/v2/exportmanager/list/preview

Exportvorschau lesen

Prüft einen Entwurf auf erlaubte Felder, Datenpfade, Ergebnisstruktur und fehlende Runtime-Inputs. Alternativ wählt export eine gespeicherte Definition. Bei ausführbarer Definition werden nach Berechtigungsprüfung höchstens zehn Zeilen gelesen; sonst leere rows mit Analysehinweisen. Speichert weder Definition noch Lauf. Ohne Body wird ein leerer Entwurf analysiert und fachlich nicht ausführbar zurückgegeben.

Operation-ID post_v2_exportmanager_list_preview

01

Vertrag & Verhalten

Dokumentationsstand
reviewed
Ändert Zustand
Nein
Als readOnly markiert
Ja
Für Automation markiert
Nein
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.

Ressource
exportmanager · expm
Levels
2, 3, 4
Dispatcher-Prüfung
Ja
03

Parameter

Header

languageoptional

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

string
Schema-Beispiel
"de"
Vollständiges Schema als JSON
{
  "type": "string",
  "examples": [
    "de"
  ]
}
X-Edoobox-If-Revisionoptional

Optional account mutation revision from a preceding authenticated auth-context snapshot. The dispatcher compares it while holding the account lock; mismatch409 requires a new review.

string
pattern
"^[a-f0-9]{32}$"
Schema-Beispiel
"aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
Vollständiges Schema als JSON
{
  "type": "string",
  "pattern": "^[a-f0-9]{32}$",
  "examples": [
    "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
  ]
}
04

Request Body

optional

application/json

object
data object

Nur Katalogfelder sind erlaubt. contexts und available_in_offer werden aus Inputs neu abgeleitet; unbekannte Eigenschaften verworfen. Gültige Definitionen benötigen mindestens eine gültige Spalte.

name string

Zum Speichern nichtleer; Kürzung auf 160 Zeichen.

description string

Kürzung auf 4000 Zeichen.

grain string

Standardwert: "auto"

Erlaubte Werte
"auto""account""offer""booking_user""date_admin"
columns array
maxItems
100
Array-Elemente
Typ nicht eingeschränkt
anyOf · Mindestens eine Variante muss passen
Variante 1 string

Selektierbarer catalog-Feldschlüssel.

Variante 2 object
field string erforderlich
label string

Kürzung auf 160 Zeichen.

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

inputs array
maxItems
10
Array-Elemente
object

fixed benötigt value. context ignoriert gespeichertes value; runtime/context werden über runtime_inputs bereitgestellt.

field string

catalog-Inputfeld, z. B. offer.id.

key string

Alias für field.

mode string

Standardwert: "runtime"

Erlaubte Werte
"runtime""fixed""context"
value string | number | boolean

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

filters array
maxItems
30
Array-Elemente
object

value ist außer für is_empty/is_not_empty erforderlich und darf nicht leer sein.

field string erforderlich

Filterbarer catalog-Feldschlüssel.

operator string

Feldabhängiger catalog-Operator, Standard equal.

value string | number | boolean

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

enabled boolean | number | string | null

Serverseitige Wahrheitswert-Normalisierung; verwenden Sie vorzugsweise JSON true oder false.

contexts array
Array-Elemente
string
available_in_offer boolean | number | string | null

Serverseitige Wahrheitswert-Normalisierung; verwenden Sie vorzugsweise JSON true oder false.

definition object

Nur Katalogfelder sind erlaubt. contexts und available_in_offer werden aus Inputs neu abgeleitet; unbekannte Eigenschaften verworfen. Gültige Definitionen benötigen mindestens eine gültige Spalte.

name string

Zum Speichern nichtleer; Kürzung auf 160 Zeichen.

description string

Kürzung auf 4000 Zeichen.

grain string

Standardwert: "auto"

Erlaubte Werte
"auto""account""offer""booking_user""date_admin"
columns array
maxItems
100
Array-Elemente
Typ nicht eingeschränkt
anyOf · Mindestens eine Variante muss passen
Variante 1 string

Selektierbarer catalog-Feldschlüssel.

Variante 2 object
field string erforderlich
label string

Kürzung auf 160 Zeichen.

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

inputs array
maxItems
10
Array-Elemente
object

fixed benötigt value. context ignoriert gespeichertes value; runtime/context werden über runtime_inputs bereitgestellt.

field string

catalog-Inputfeld, z. B. offer.id.

key string

Alias für field.

mode string

Standardwert: "runtime"

Erlaubte Werte
"runtime""fixed""context"
value string | number | boolean

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

filters array
maxItems
30
Array-Elemente
object

value ist außer für is_empty/is_not_empty erforderlich und darf nicht leer sein.

field string erforderlich

Filterbarer catalog-Feldschlüssel.

operator string

Feldabhängiger catalog-Operator, Standard equal.

value string | number | boolean

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

enabled boolean | number | string | null

Serverseitige Wahrheitswert-Normalisierung; verwenden Sie vorzugsweise JSON true oder false.

contexts array
Array-Elemente
string
available_in_offer boolean | number | string | null

Serverseitige Wahrheitswert-Normalisierung; verwenden Sie vorzugsweise JSON true oder false.

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

runtime_inputs object
Schema für zusätzliche Felder
string | number | boolean
export string

Öffentliche v2-ID aus dem ausgewählten Konto; Beispiel ist synthetisch.

pattern
"^exportmanager_[a-f0-9]{12}_-?[0-9]+$"
Schema-Beispiel
"exportmanager_012345abcdef_123456"

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

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

Vollständiges Schema als JSON
{
  "type": "object",
  "properties": {
    "data": {
      "type": "object",
      "properties": {
        "name": {
          "type": "string",
          "description": "Zum Speichern nichtleer; Kürzung auf 160 Zeichen."
        },
        "description": {
          "type": "string",
          "description": "Kürzung auf 4000 Zeichen."
        },
        "grain": {
          "type": "string",
          "enum": [
            "auto",
            "account",
            "offer",
            "booking_user",
            "date_admin"
          ],
          "default": "auto"
        },
        "columns": {
          "type": "array",
          "items": {
            "anyOf": [
              {
                "type": "string",
                "description": "Selektierbarer catalog-Feldschlüssel."
              },
              {
                "type": "object",
                "properties": {
                  "field": {
                    "type": "string"
                  },
                  "label": {
                    "type": "string",
                    "description": "Kürzung auf 160 Zeichen."
                  }
                },
                "additionalProperties": true,
                "required": [
                  "field"
                ]
              }
            ]
          },
          "maxItems": 100
        },
        "inputs": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "field": {
                "type": "string",
                "description": "catalog-Inputfeld, z. B. offer.id."
              },
              "key": {
                "type": "string",
                "description": "Alias für field."
              },
              "mode": {
                "type": "string",
                "enum": [
                  "runtime",
                  "fixed",
                  "context"
                ],
                "default": "runtime"
              },
              "value": {
                "type": [
                  "string",
                  "number",
                  "boolean"
                ]
              }
            },
            "additionalProperties": true,
            "description": "fixed benötigt value. context ignoriert gespeichertes value; runtime/context werden über runtime_inputs bereitgestellt."
          },
          "maxItems": 10
        },
        "filters": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "field": {
                "type": "string",
                "description": "Filterbarer catalog-Feldschlüssel."
              },
              "operator": {
                "type": "string",
                "description": "Feldabhängiger catalog-Operator, Standard equal."
              },
              "value": {
                "type": [
                  "string",
                  "number",
                  "boolean"
                ]
              }
            },
            "additionalProperties": true,
            "required": [
              "field"
            ],
            "description": "value ist außer für is_empty/is_not_empty erforderlich und darf nicht leer sein."
          },
          "maxItems": 30
        },
        "enabled": {
          "type": [
            "boolean",
            "number",
            "string",
            "null"
          ],
          "description": "Serverseitige Wahrheitswert-Normalisierung; verwenden Sie vorzugsweise JSON true oder false."
        },
        "contexts": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "available_in_offer": {
          "type": [
            "boolean",
            "number",
            "string",
            "null"
          ],
          "description": "Serverseitige Wahrheitswert-Normalisierung; verwenden Sie vorzugsweise JSON true oder false."
        },
        "definition": {
          "type": "object",
          "properties": {
            "name": {
              "type": "string",
              "description": "Zum Speichern nichtleer; Kürzung auf 160 Zeichen."
            },
            "description": {
              "type": "string",
              "description": "Kürzung auf 4000 Zeichen."
            },
            "grain": {
              "type": "string",
              "enum": [
                "auto",
                "account",
                "offer",
                "booking_user",
                "date_admin"
              ],
              "default": "auto"
            },
            "columns": {
              "type": "array",
              "items": {
                "anyOf": [
                  {
                    "type": "string",
                    "description": "Selektierbarer catalog-Feldschlüssel."
                  },
                  {
                    "type": "object",
                    "properties": {
                      "field": {
                        "type": "string"
                      },
                      "label": {
                        "type": "string",
                        "description": "Kürzung auf 160 Zeichen."
                      }
                    },
                    "additionalProperties": true,
                    "required": [
                      "field"
                    ]
                  }
                ]
              },
              "maxItems": 100
            },
            "inputs": {
              "type": "array",
              "items": {
                "type": "object",
                "properties": {
                  "field": {
                    "type": "string",
                    "description": "catalog-Inputfeld, z. B. offer.id."
                  },
                  "key": {
                    "type": "string",
                    "description": "Alias für field."
                  },
                  "mode": {
                    "type": "string",
                    "enum": [
                      "runtime",
                      "fixed",
                      "context"
                    ],
                    "default": "runtime"
                  },
                  "value": {
                    "type": [
                      "string",
                      "number",
                      "boolean"
                    ]
                  }
                },
                "additionalProperties": true,
                "description": "fixed benötigt value. context ignoriert gespeichertes value; runtime/context werden über runtime_inputs bereitgestellt."
              },
              "maxItems": 10
            },
            "filters": {
              "type": "array",
              "items": {
                "type": "object",
                "properties": {
                  "field": {
                    "type": "string",
                    "description": "Filterbarer catalog-Feldschlüssel."
                  },
                  "operator": {
                    "type": "string",
                    "description": "Feldabhängiger catalog-Operator, Standard equal."
                  },
                  "value": {
                    "type": [
                      "string",
                      "number",
                      "boolean"
                    ]
                  }
                },
                "additionalProperties": true,
                "required": [
                  "field"
                ],
                "description": "value ist außer für is_empty/is_not_empty erforderlich und darf nicht leer sein."
              },
              "maxItems": 30
            },
            "enabled": {
              "type": [
                "boolean",
                "number",
                "string",
                "null"
              ],
              "description": "Serverseitige Wahrheitswert-Normalisierung; verwenden Sie vorzugsweise JSON true oder false."
            },
            "contexts": {
              "type": "array",
              "items": {
                "type": "string"
              }
            },
            "available_in_offer": {
              "type": [
                "boolean",
                "number",
                "string",
                "null"
              ],
              "description": "Serverseitige Wahrheitswert-Normalisierung; verwenden Sie vorzugsweise JSON true oder false."
            }
          },
          "additionalProperties": true,
          "description": "Nur Katalogfelder sind erlaubt. contexts und available_in_offer werden aus Inputs neu abgeleitet; unbekannte Eigenschaften verworfen. Gültige Definitionen benötigen mindestens eine gültige Spalte."
        },
        "runtime_inputs": {
          "type": "object",
          "additionalProperties": {
            "type": [
              "string",
              "number",
              "boolean"
            ]
          }
        },
        "export": {
          "type": "string",
          "pattern": "^exportmanager_[a-f0-9]{12}_-?[0-9]+$",
          "examples": [
            "exportmanager_012345abcdef_123456"
          ],
          "description": "Öffentliche v2-ID aus dem ausgewählten Konto; Beispiel ist synthetisch."
        }
      },
      "additionalProperties": true,
      "description": "Nur Katalogfelder sind erlaubt. contexts und available_in_offer werden aus Inputs neu abgeleitet; unbekannte Eigenschaften verworfen. Gültige Definitionen benötigen mindestens eine gültige Spalte."
    }
  },
  "additionalProperties": true
}
Exportvorschau lesen
{
  "data": {
    "name": "Angebotsliste",
    "grain": "offer",
    "columns": [
      {
        "field": "offer.id",
        "label": "ID"
      },
      {
        "field": "offer.name",
        "label": "Angebot"
      }
    ],
    "inputs": [
      {
        "field": "offer.id",
        "mode": "runtime"
      }
    ],
    "filters": [],
    "enabled": true,
    "runtime_inputs": {
      "offer.id": "offer_012345abcdef_123456"
    }
  }
}
05

Antworten

11

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

200application/json

Vorschau mit columns, rows, has_more, analysis und öffentlichem plan.

Response Header

X-Edoobox-Revision

Rotated account revision supplied for the next action in one reviewed sequence.

string
pattern
"^[a-f0-9]{32}$"
Vollständiges Schema als JSON
{
  "type": "string",
  "pattern": "^[a-f0-9]{32}$"
}

application/json

object
success boolean
error boolean | string
error_code string
data object
columns array
Array-Elemente
object
key string
field string
label string
type string

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

rows array
Array-Elemente
object

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

has_more boolean
analysis object
valid boolean
active_groups array
Array-Elemente
string
reachable_groups array
Array-Elemente
string
required_nodes array
Array-Elemente
string
suggested_grain string
grain string
warnings array
Array-Elemente
object
path string
code string
message string

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

errors array
Array-Elemente
object
path string
code string
message string

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

recommendations array
Array-Elemente
object

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

can_preview boolean

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

plan Typ nicht eingeschränkt
anyOf · Mindestens eine Variante muss passen
Variante 1 object
grain string
groups array
Array-Elemente
string

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

Variante 2 null

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": {
        "columns": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "key": {
                "type": "string"
              },
              "field": {
                "type": "string"
              },
              "label": {
                "type": "string"
              },
              "type": {
                "type": "string"
              }
            },
            "additionalProperties": true
          }
        },
        "rows": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {},
            "additionalProperties": true
          }
        },
        "has_more": {
          "type": "boolean"
        },
        "analysis": {
          "type": "object",
          "properties": {
            "valid": {
              "type": "boolean"
            },
            "active_groups": {
              "type": "array",
              "items": {
                "type": "string"
              }
            },
            "reachable_groups": {
              "type": "array",
              "items": {
                "type": "string"
              }
            },
            "required_nodes": {
              "type": "array",
              "items": {
                "type": "string"
              }
            },
            "suggested_grain": {
              "type": "string"
            },
            "grain": {
              "type": "string"
            },
            "warnings": {
              "type": "array",
              "items": {
                "type": "object",
                "properties": {
                  "path": {
                    "type": "string"
                  },
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  }
                },
                "additionalProperties": true
              }
            },
            "errors": {
              "type": "array",
              "items": {
                "type": "object",
                "properties": {
                  "path": {
                    "type": "string"
                  },
                  "code": {
                    "type": "string"
                  },
                  "message": {
                    "type": "string"
                  }
                },
                "additionalProperties": true
              }
            },
            "recommendations": {
              "type": "array",
              "items": {
                "type": "object",
                "properties": {},
                "additionalProperties": true
              }
            },
            "can_preview": {
              "type": "boolean"
            }
          },
          "additionalProperties": true
        },
        "plan": {
          "anyOf": [
            {
              "type": "object",
              "properties": {
                "grain": {
                  "type": "string"
                },
                "groups": {
                  "type": "array",
                  "items": {
                    "type": "string"
                  }
                }
              },
              "additionalProperties": true
            },
            {
              "type": "null"
            }
          ]
        }
      },
      "additionalProperties": true
    },
    "type": {
      "type": "string"
    }
  },
  "additionalProperties": true
}
Beispiel
{
  "success": true,
  "error": false,
  "data": {
    "columns": [
      {
        "key": "account_name",
        "field": "account.name",
        "label": "Organisation",
        "type": "string"
      }
    ],
    "rows": [
      {
        "account_name": "Beispielorganisation"
      }
    ],
    "has_more": false,
    "analysis": {
      "valid": true,
      "active_groups": [
        "account"
      ],
      "reachable_groups": [
        "account"
      ],
      "required_nodes": [
        "account"
      ],
      "suggested_grain": "account",
      "grain": "account",
      "warnings": [],
      "recommendations": [],
      "errors": [],
      "can_preview": true
    },
    "plan": {
      "grain": "account",
      "groups": [
        "account"
      ]
    }
  }
}
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"
}
409application/json

The account changed after the reviewed read. No domain operation is dispatched; obtain fresh state and review again.

application/json

object

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

Vollständiges Schema als JSON
{
  "type": "object",
  "additionalProperties": true
}
Beispiel
{
  "error": "ED40901",
  "error_code": "mutation_revision_conflict"
}
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"
}
503application/json

The account mutation lock or revision store is unavailable. No unprotected fallback is executed.

Response Header

Retry-After

integer

Fester Wert: 1

Vollständiges Schema als JSON
{
  "type": "integer",
  "const": 1
}

application/json

object

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

Vollständiges Schema als JSON
{
  "type": "object",
  "additionalProperties": true
}
Beispiel
{
  "error": "ED50301",
  "error_code": "mutation_revision_busy"
}
06

Quelle & Metadaten

Quelle laut Spezifikationapplication/models/v2/Exportmanager.php:117postExportmanager()

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-runtimeMutationGuard
true
x-edoobox-documentationReview
{
  "file": "docs/openapi/operation-contracts/08-subscriptions.json",
  "notes": []
}
x-edoobox-source
{
  "file": "application/models/v2/Exportmanager.php",
  "method": "postExportmanager",
  "line": 117,
  "branch": {
    "file": "application/models/v2/Exportmanager.php",
    "line": 128
  }
}
x-edoobox-documentationStatus
"reviewed"
x-edoobox-readOnly
true
x-edoobox-safeForAutomation
false
x-edoobox-permission
{
  "resource": "exportmanager",
  "short": "expm",
  "checkedByDispatcher": true,
  "levels": [
    2,
    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": "post_v2_exportmanager_list_preview",
  "summary": "Exportvorschau lesen",
  "description": "Prüft einen Entwurf auf erlaubte Felder, Datenpfade, Ergebnisstruktur und fehlende Runtime-Inputs. Alternativ wählt export eine gespeicherte Definition. Bei ausführbarer Definition werden nach Berechtigungsprüfung höchstens zehn Zeilen gelesen; sonst leere rows mit Analysehinweisen. Speichert weder Definition noch Lauf. Ohne Body wird ein leerer Entwurf analysiert und fachlich nicht ausführbar zurückgegeben.",
  "tags": [
    "exportmanager"
  ],
  "security": [
    {
      "bearerAuth": [],
      "accountContext": []
    },
    {
      "sessionCookie": [],
      "accountContext": []
    }
  ],
  "parameters": [
    {
      "name": "language",
      "in": "header",
      "required": false,
      "description": "Account language code, where the resource supports setLanguage().",
      "schema": {
        "type": "string",
        "examples": [
          "de"
        ]
      }
    },
    {
      "name": "X-Edoobox-If-Revision",
      "in": "header",
      "required": false,
      "schema": {
        "type": "string",
        "pattern": "^[a-f0-9]{32}$",
        "examples": [
          "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
        ]
      },
      "description": "Optional account mutation revision from a preceding authenticated auth-context snapshot. The dispatcher compares it while holding the account lock; mismatch409 requires a new review."
    }
  ],
  "responses": {
    "200": {
      "description": "Vorschau mit columns, rows, has_more, analysis und öffentlichem plan.",
      "content": {
        "application/json": {
          "example": {
            "success": true,
            "error": false,
            "data": {
              "columns": [
                {
                  "key": "account_name",
                  "field": "account.name",
                  "label": "Organisation",
                  "type": "string"
                }
              ],
              "rows": [
                {
                  "account_name": "Beispielorganisation"
                }
              ],
              "has_more": false,
              "analysis": {
                "valid": true,
                "active_groups": [
                  "account"
                ],
                "reachable_groups": [
                  "account"
                ],
                "required_nodes": [
                  "account"
                ],
                "suggested_grain": "account",
                "grain": "account",
                "warnings": [],
                "recommendations": [],
                "errors": [],
                "can_preview": true
              },
              "plan": {
                "grain": "account",
                "groups": [
                  "account"
                ]
              }
            }
          },
          "schema": {
            "type": "object",
            "properties": {
              "success": {
                "type": "boolean"
              },
              "error": {
                "type": [
                  "boolean",
                  "string"
                ]
              },
              "error_code": {
                "type": "string"
              },
              "data": {
                "type": "object",
                "properties": {
                  "columns": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "properties": {
                        "key": {
                          "type": "string"
                        },
                        "field": {
                          "type": "string"
                        },
                        "label": {
                          "type": "string"
                        },
                        "type": {
                          "type": "string"
                        }
                      },
                      "additionalProperties": true
                    }
                  },
                  "rows": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "properties": {},
                      "additionalProperties": true
                    }
                  },
                  "has_more": {
                    "type": "boolean"
                  },
                  "analysis": {
                    "type": "object",
                    "properties": {
                      "valid": {
                        "type": "boolean"
                      },
                      "active_groups": {
                        "type": "array",
                        "items": {
                          "type": "string"
                        }
                      },
                      "reachable_groups": {
                        "type": "array",
                        "items": {
                          "type": "string"
                        }
                      },
                      "required_nodes": {
                        "type": "array",
                        "items": {
                          "type": "string"
                        }
                      },
                      "suggested_grain": {
                        "type": "string"
                      },
                      "grain": {
                        "type": "string"
                      },
                      "warnings": {
                        "type": "array",
                        "items": {
                          "type": "object",
                          "properties": {
                            "path": {
                              "type": "string"
                            },
                            "code": {
                              "type": "string"
                            },
                            "message": {
                              "type": "string"
                            }
                          },
                          "additionalProperties": true
                        }
                      },
                      "errors": {
                        "type": "array",
                        "items": {
                          "type": "object",
                          "properties": {
                            "path": {
                              "type": "string"
                            },
                            "code": {
                              "type": "string"
                            },
                            "message": {
                              "type": "string"
                            }
                          },
                          "additionalProperties": true
                        }
                      },
                      "recommendations": {
                        "type": "array",
                        "items": {
                          "type": "object",
                          "properties": {},
                          "additionalProperties": true
                        }
                      },
                      "can_preview": {
                        "type": "boolean"
                      }
                    },
                    "additionalProperties": true
                  },
                  "plan": {
                    "anyOf": [
                      {
                        "type": "object",
                        "properties": {
                          "grain": {
                            "type": "string"
                          },
                          "groups": {
                            "type": "array",
                            "items": {
                              "type": "string"
                            }
                          }
                        },
                        "additionalProperties": true
                      },
                      {
                        "type": "null"
                      }
                    ]
                  }
                },
                "additionalProperties": true
              },
              "type": {
                "type": "string"
              }
            },
            "additionalProperties": true
          }
        }
      },
      "headers": {
        "X-Edoobox-Revision": {
          "schema": {
            "type": "string",
            "pattern": "^[a-f0-9]{32}$"
          },
          "description": "Rotated account revision supplied for the next action in one reviewed sequence."
        }
      }
    },
    "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"
          }
        }
      }
    },
    "409": {
      "description": "The account changed after the reviewed read. No domain operation is dispatched; obtain fresh state and review again.",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": true
          },
          "example": {
            "error": "ED40901",
            "error_code": "mutation_revision_conflict"
          }
        }
      }
    },
    "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"
          }
        }
      }
    },
    "503": {
      "description": "The account mutation lock or revision store is unavailable. No unprotected fallback is executed.",
      "headers": {
        "Retry-After": {
          "schema": {
            "type": "integer",
            "const": 1
          }
        }
      },
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": true
          },
          "example": {
            "error": "ED50301",
            "error_code": "mutation_revision_busy"
          }
        }
      }
    }
  },
  "x-edoobox-mutates-state": false,
  "requestBody": {
    "required": false,
    "content": {
      "application/json": {
        "schema": {
          "type": "object",
          "properties": {
            "data": {
              "type": "object",
              "properties": {
                "name": {
                  "type": "string",
                  "description": "Zum Speichern nichtleer; Kürzung auf 160 Zeichen."
                },
                "description": {
                  "type": "string",
                  "description": "Kürzung auf 4000 Zeichen."
                },
                "grain": {
                  "type": "string",
                  "enum": [
                    "auto",
                    "account",
                    "offer",
                    "booking_user",
                    "date_admin"
                  ],
                  "default": "auto"
                },
                "columns": {
                  "type": "array",
                  "items": {
                    "anyOf": [
                      {
                        "type": "string",
                        "description": "Selektierbarer catalog-Feldschlüssel."
                      },
                      {
                        "type": "object",
                        "properties": {
                          "field": {
                            "type": "string"
                          },
                          "label": {
                            "type": "string",
                            "description": "Kürzung auf 160 Zeichen."
                          }
                        },
                        "additionalProperties": true,
                        "required": [
                          "field"
                        ]
                      }
                    ]
                  },
                  "maxItems": 100
                },
                "inputs": {
                  "type": "array",
                  "items": {
                    "type": "object",
                    "properties": {
                      "field": {
                        "type": "string",
                        "description": "catalog-Inputfeld, z. B. offer.id."
                      },
                      "key": {
                        "type": "string",
                        "description": "Alias für field."
                      },
                      "mode": {
                        "type": "string",
                        "enum": [
                          "runtime",
                          "fixed",
                          "context"
                        ],
                        "default": "runtime"
                      },
                      "value": {
                        "type": [
                          "string",
                          "number",
                          "boolean"
                        ]
                      }
                    },
                    "additionalProperties": true,
                    "description": "fixed benötigt value. context ignoriert gespeichertes value; runtime/context werden über runtime_inputs bereitgestellt."
                  },
                  "maxItems": 10
                },
                "filters": {
                  "type": "array",
                  "items": {
                    "type": "object",
                    "properties": {
                      "field": {
                        "type": "string",
                        "description": "Filterbarer catalog-Feldschlüssel."
                      },
                      "operator": {
                        "type": "string",
                        "description": "Feldabhängiger catalog-Operator, Standard equal."
                      },
                      "value": {
                        "type": [
                          "string",
                          "number",
                          "boolean"
                        ]
                      }
                    },
                    "additionalProperties": true,
                    "required": [
                      "field"
                    ],
                    "description": "value ist außer für is_empty/is_not_empty erforderlich und darf nicht leer sein."
                  },
                  "maxItems": 30
                },
                "enabled": {
                  "type": [
                    "boolean",
                    "number",
                    "string",
                    "null"
                  ],
                  "description": "Serverseitige Wahrheitswert-Normalisierung; verwenden Sie vorzugsweise JSON true oder false."
                },
                "contexts": {
                  "type": "array",
                  "items": {
                    "type": "string"
                  }
                },
                "available_in_offer": {
                  "type": [
                    "boolean",
                    "number",
                    "string",
                    "null"
                  ],
                  "description": "Serverseitige Wahrheitswert-Normalisierung; verwenden Sie vorzugsweise JSON true oder false."
                },
                "definition": {
                  "type": "object",
                  "properties": {
                    "name": {
                      "type": "string",
                      "description": "Zum Speichern nichtleer; Kürzung auf 160 Zeichen."
                    },
                    "description": {
                      "type": "string",
                      "description": "Kürzung auf 4000 Zeichen."
                    },
                    "grain": {
                      "type": "string",
                      "enum": [
                        "auto",
                        "account",
                        "offer",
                        "booking_user",
                        "date_admin"
                      ],
                      "default": "auto"
                    },
                    "columns": {
                      "type": "array",
                      "items": {
                        "anyOf": [
                          {
                            "type": "string",
                            "description": "Selektierbarer catalog-Feldschlüssel."
                          },
                          {
                            "type": "object",
                            "properties": {
                              "field": {
                                "type": "string"
                              },
                              "label": {
                                "type": "string",
                                "description": "Kürzung auf 160 Zeichen."
                              }
                            },
                            "additionalProperties": true,
                            "required": [
                              "field"
                            ]
                          }
                        ]
                      },
                      "maxItems": 100
                    },
                    "inputs": {
                      "type": "array",
                      "items": {
                        "type": "object",
                        "properties": {
                          "field": {
                            "type": "string",
                            "description": "catalog-Inputfeld, z. B. offer.id."
                          },
                          "key": {
                            "type": "string",
                            "description": "Alias für field."
                          },
                          "mode": {
                            "type": "string",
                            "enum": [
                              "runtime",
                              "fixed",
                              "context"
                            ],
                            "default": "runtime"
                          },
                          "value": {
                            "type": [
                              "string",
                              "number",
                              "boolean"
                            ]
                          }
                        },
                        "additionalProperties": true,
                        "description": "fixed benötigt value. context ignoriert gespeichertes value; runtime/context werden über runtime_inputs bereitgestellt."
                      },
                      "maxItems": 10
                    },
                    "filters": {
                      "type": "array",
                      "items": {
                        "type": "object",
                        "properties": {
                          "field": {
                            "type": "string",
                            "description": "Filterbarer catalog-Feldschlüssel."
                          },
                          "operator": {
                            "type": "string",
                            "description": "Feldabhängiger catalog-Operator, Standard equal."
                          },
                          "value": {
                            "type": [
                              "string",
                              "number",
                              "boolean"
                            ]
                          }
                        },
                        "additionalProperties": true,
                        "required": [
                          "field"
                        ],
                        "description": "value ist außer für is_empty/is_not_empty erforderlich und darf nicht leer sein."
                      },
                      "maxItems": 30
                    },
                    "enabled": {
                      "type": [
                        "boolean",
                        "number",
                        "string",
                        "null"
                      ],
                      "description": "Serverseitige Wahrheitswert-Normalisierung; verwenden Sie vorzugsweise JSON true oder false."
                    },
                    "contexts": {
                      "type": "array",
                      "items": {
                        "type": "string"
                      }
                    },
                    "available_in_offer": {
                      "type": [
                        "boolean",
                        "number",
                        "string",
                        "null"
                      ],
                      "description": "Serverseitige Wahrheitswert-Normalisierung; verwenden Sie vorzugsweise JSON true oder false."
                    }
                  },
                  "additionalProperties": true,
                  "description": "Nur Katalogfelder sind erlaubt. contexts und available_in_offer werden aus Inputs neu abgeleitet; unbekannte Eigenschaften verworfen. Gültige Definitionen benötigen mindestens eine gültige Spalte."
                },
                "runtime_inputs": {
                  "type": "object",
                  "additionalProperties": {
                    "type": [
                      "string",
                      "number",
                      "boolean"
                    ]
                  }
                },
                "export": {
                  "type": "string",
                  "pattern": "^exportmanager_[a-f0-9]{12}_-?[0-9]+$",
                  "examples": [
                    "exportmanager_012345abcdef_123456"
                  ],
                  "description": "Öffentliche v2-ID aus dem ausgewählten Konto; Beispiel ist synthetisch."
                }
              },
              "additionalProperties": true,
              "description": "Nur Katalogfelder sind erlaubt. contexts und available_in_offer werden aus Inputs neu abgeleitet; unbekannte Eigenschaften verworfen. Gültige Definitionen benötigen mindestens eine gültige Spalte."
            }
          },
          "additionalProperties": true
        },
        "examples": {
          "request": {
            "summary": "Exportvorschau lesen",
            "value": {
              "data": {
                "name": "Angebotsliste",
                "grain": "offer",
                "columns": [
                  {
                    "field": "offer.id",
                    "label": "ID"
                  },
                  {
                    "field": "offer.name",
                    "label": "Angebot"
                  }
                ],
                "inputs": [
                  {
                    "field": "offer.id",
                    "mode": "runtime"
                  }
                ],
                "filters": [],
                "enabled": true,
                "runtime_inputs": {
                  "offer.id": "offer_012345abcdef_123456"
                }
              }
            }
          }
        }
      }
    }
  },
  "x-edoobox-runtimeMutationGuard": true,
  "x-edoobox-documentationReview": {
    "file": "docs/openapi/operation-contracts/08-subscriptions.json",
    "notes": []
  },
  "x-edoobox-source": {
    "file": "application/models/v2/Exportmanager.php",
    "method": "postExportmanager",
    "line": 117,
    "branch": {
      "file": "application/models/v2/Exportmanager.php",
      "line": 128
    }
  },
  "x-edoobox-documentationStatus": "reviewed",
  "x-edoobox-readOnly": true,
  "x-edoobox-safeForAutomation": false,
  "x-edoobox-permission": {
    "resource": "exportmanager",
    "short": "expm",
    "checkedByDispatcher": true,
    "levels": [
      2,
      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."
  }
}
Cookies & Datenschutz
Notwendig

Für Sicherheit, Navigation, Formulare und den technischen Betrieb der Website.

Immer aktiv
Datenschutzerklärung