POST/v2/exportmanager

Individuelle Exportdefinition anlegen

Speichert eine vollständige validierte Definition. name und mindestens eine gültige columns-Spalte sind erforderlich; Inputs, Filter und grain müssen zu Katalog und Datenabhängigkeiten passen. Metadaten können in data oder data.definition stehen; äußere Metadaten überschreiben innere. contexts und available_in_offer werden neu abgeleitet. Noch kein CSV-Lauf wird erzeugt.

Operation-ID post_v2_exportmanager

Vertrag & Verhalten

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

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

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

Request Body

erforderlich

`application/json`

object

data Typ nicht eingeschränkt erforderlich

anyOf · Mindestens eine Variante muss passen

Variante 1 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 erforderlich

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 erforderlich

minItems: 1
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.

Variante 2 object

definition object erforderlich

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.

name string

Zum Speichern nichtleer; Kürzung auf 160 Zeichen.

description string

Kürzung auf 4000 Zeichen.

enabled boolean | number | string | null

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

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.

Vollständiges Schema als JSON

{
  "type": "object",
  "properties": {
    "data": {
      "anyOf": [
        {
          "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,
              "minItems": 1
            },
            "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.",
          "required": [
            "name",
            "columns"
          ]
        },
        {
          "type": "object",
          "properties": {
            "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."
            },
            "name": {
              "type": "string",
              "description": "Zum Speichern nichtleer; Kürzung auf 160 Zeichen."
            },
            "description": {
              "type": "string",
              "description": "Kürzung auf 4000 Zeichen."
            },
            "enabled": {
              "type": [
                "boolean",
                "number",
                "string",
                "null"
              ],
              "description": "Serverseitige Wahrheitswert-Normalisierung; verwenden Sie vorzugsweise JSON true oder false."
            },
            "available_in_offer": {
              "type": [
                "boolean",
                "number",
                "string",
                "null"
              ],
              "description": "Serverseitige Wahrheitswert-Normalisierung; verwenden Sie vorzugsweise JSON true oder false."
            }
          },
          "additionalProperties": true,
          "required": [
            "definition"
          ]
        }
      ]
    }
  },
  "additionalProperties": true,
  "required": [
    "data"
  ]
}

Individuelle Exportdefinition anlegen

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

Antworten

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

200application/json

Response; inspect error and success as legacy failures may also use HTTP 200.

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

insert boolean

id 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"

export object

id 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"

name string

description string

enabled boolean

available_in_offer boolean

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.

definition_version integer

created_at integer

updated_at integer

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": {
        "insert": {
          "type": "boolean"
        },
        "id": {
          "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."
        },
        "export": {
          "type": "object",
          "properties": {
            "id": {
              "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."
            },
            "name": {
              "type": "string"
            },
            "description": {
              "type": "string"
            },
            "enabled": {
              "type": "boolean"
            },
            "available_in_offer": {
              "type": "boolean"
            },
            "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."
            },
            "definition_version": {
              "type": "integer"
            },
            "created_at": {
              "type": "integer"
            },
            "updated_at": {
              "type": "integer"
            }
          },
          "additionalProperties": true
        }
      },
      "additionalProperties": true
    },
    "type": {
      "type": "string"
    }
  },
  "additionalProperties": true
}

Beispiel

{
  "success": true,
  "error": false,
  "data": {
    "insert": true,
    "id": "exportmanager_012345abcdef_123456",
    "export": {
      "id": "exportmanager_012345abcdef_123456",
      "name": "Kontobezeichnung",
      "description": "Beispieldefinition",
      "enabled": true,
      "available_in_offer": false,
      "definition": {
        "name": "Kontobezeichnung",
        "description": "Beispieldefinition",
        "contexts": [
          "global"
        ],
        "grain": "account",
        "inputs": [],
        "filters": [],
        "columns": [
          {
            "field": "account.name",
            "key": "account_name",
            "label": "Organisation"
          }
        ],
        "enabled": true,
        "available_in_offer": false
      },
      "definition_version": 1,
      "created_at": 1792627200,
      "updated_at": 1792627200
    }
  }
}

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

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

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

true

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
}

x-edoobox-documentationStatus

"reviewed"

x-edoobox-readOnly

false

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",
  "summary": "Individuelle Exportdefinition anlegen",
  "description": "Speichert eine vollständige validierte Definition. name und mindestens eine gültige columns-Spalte sind erforderlich; Inputs, Filter und grain müssen zu Katalog und Datenabhängigkeiten passen. Metadaten können in data oder data.definition stehen; äußere Metadaten überschreiben innere. contexts und available_in_offer werden neu abgeleitet. Noch kein CSV-Lauf wird erzeugt.",
  "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": "Response; inspect error and success as legacy failures may also use HTTP 200.",
      "content": {
        "application/json": {
          "example": {
            "success": true,
            "error": false,
            "data": {
              "insert": true,
              "id": "exportmanager_012345abcdef_123456",
              "export": {
                "id": "exportmanager_012345abcdef_123456",
                "name": "Kontobezeichnung",
                "description": "Beispieldefinition",
                "enabled": true,
                "available_in_offer": false,
                "definition": {
                  "name": "Kontobezeichnung",
                  "description": "Beispieldefinition",
                  "contexts": [
                    "global"
                  ],
                  "grain": "account",
                  "inputs": [],
                  "filters": [],
                  "columns": [
                    {
                      "field": "account.name",
                      "key": "account_name",
                      "label": "Organisation"
                    }
                  ],
                  "enabled": true,
                  "available_in_offer": false
                },
                "definition_version": 1,
                "created_at": 1792627200,
                "updated_at": 1792627200
              }
            }
          },
          "schema": {
            "type": "object",
            "properties": {
              "success": {
                "type": "boolean"
              },
              "error": {
                "type": [
                  "boolean",
                  "string"
                ]
              },
              "error_code": {
                "type": "string"
              },
              "data": {
                "type": "object",
                "properties": {
                  "insert": {
                    "type": "boolean"
                  },
                  "id": {
                    "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."
                  },
                  "export": {
                    "type": "object",
                    "properties": {
                      "id": {
                        "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."
                      },
                      "name": {
                        "type": "string"
                      },
                      "description": {
                        "type": "string"
                      },
                      "enabled": {
                        "type": "boolean"
                      },
                      "available_in_offer": {
                        "type": "boolean"
                      },
                      "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."
                      },
                      "definition_version": {
                        "type": "integer"
                      },
                      "created_at": {
                        "type": "integer"
                      },
                      "updated_at": {
                        "type": "integer"
                      }
                    },
                    "additionalProperties": true
                  }
                },
                "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": true,
  "requestBody": {
    "required": true,
    "content": {
      "application/json": {
        "schema": {
          "type": "object",
          "properties": {
            "data": {
              "anyOf": [
                {
                  "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,
                      "minItems": 1
                    },
                    "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.",
                  "required": [
                    "name",
                    "columns"
                  ]
                },
                {
                  "type": "object",
                  "properties": {
                    "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."
                    },
                    "name": {
                      "type": "string",
                      "description": "Zum Speichern nichtleer; Kürzung auf 160 Zeichen."
                    },
                    "description": {
                      "type": "string",
                      "description": "Kürzung auf 4000 Zeichen."
                    },
                    "enabled": {
                      "type": [
                        "boolean",
                        "number",
                        "string",
                        "null"
                      ],
                      "description": "Serverseitige Wahrheitswert-Normalisierung; verwenden Sie vorzugsweise JSON true oder false."
                    },
                    "available_in_offer": {
                      "type": [
                        "boolean",
                        "number",
                        "string",
                        "null"
                      ],
                      "description": "Serverseitige Wahrheitswert-Normalisierung; verwenden Sie vorzugsweise JSON true oder false."
                    }
                  },
                  "additionalProperties": true,
                  "required": [
                    "definition"
                  ]
                }
              ]
            }
          },
          "additionalProperties": true,
          "required": [
            "data"
          ]
        },
        "examples": {
          "request": {
            "summary": "Individuelle Exportdefinition anlegen",
            "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
              }
            }
          }
        }
      }
    }
  },
  "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
  },
  "x-edoobox-documentationStatus": "reviewed",
  "x-edoobox-readOnly": false,
  "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."
  }
}

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.
# Request Body: synthetisches Beispiel aus der Spezifikation; Werte und Vollständigkeit vor Verwendung prüfen.
: "${API_ORIGIN:?API_ORIGIN setzen}"
: "${AUTH_BEARERAUTH:?AUTH_BEARERAUTH setzen}"
: "${AUTH_ACCOUNTCONTEXT:?AUTH_ACCOUNTCONTEXT setzen}"
cat > payload.json <<'EDOOBOX_JSON_EXAMPLE'
{
  "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
  }
}
EDOOBOX_JSON_EXAMPLE
curl --request 'POST' \
  --url "${API_ORIGIN%/}"'/v2/exportmanager' \
  --header 'Authorization: Bearer '"${AUTH_BEARERAUTH}" \
  --header 'edid: '"${AUTH_ACCOUNTCONTEXT}" \
  --header 'Content-Type: application/json' \
  --data-binary '@payload.json'

JavaScript

// Zeigt Authentifizierungsalternative 1; alle Verfahren dieser Alternative sind gemeinsam erforderlich.
// Request Body: synthetisches Beispiel aus der Spezifikation; Werte und Vollständigkeit vor Verwendung prüfen.
const required = (name) => {
  const value = process.env[name];
  if (!value) throw new Error(`Set ${name}`);
  return value;
};
let path = "/v2/exportmanager";
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");
headers['Content-Type'] = "application/json";
const body = JSON.stringify({
  "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
  }
});
const response = await fetch(url, { method: "POST", headers, body, 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.
# Request Body: synthetisches Beispiel aus der Spezifikation; Werte und Vollständigkeit vor Verwendung prüfen.
import os
import urllib.parse
import urllib.request
import urllib.error

path = "/v2/exportmanager"
url = os.environ["API_ORIGIN"].rstrip("/") + path
headers = {}
headers["Authorization"] = "Bearer " + os.environ["AUTH_BEARERAUTH"]
headers["edid"] = "" + os.environ["AUTH_ACCOUNTCONTEXT"]
headers["Content-Type"] = "application/json"
body = "{\"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}}".encode("utf-8")

# 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="POST", data=body)
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.
// Request Body: synthetisches Beispiel aus der Spezifikation; Werte und Vollständigkeit vor Verwendung prüfen.
const required = (name) => {
  const value = process.env[name];
  if (!value) throw new Error(`Set ${name}`);
  return value;
};
let path = "/v2/exportmanager";
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");
headers['Content-Type'] = "application/json";
const body = JSON.stringify({
  "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
  }
});
const response = await fetch(url, { method: "POST", headers, body, 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.
# Request Body: synthetisches Beispiel aus der Spezifikation; Werte und Vollständigkeit vor Verwendung prüfen.
import os
import urllib.parse
import urllib.request
import urllib.error

path = "/v2/exportmanager"
url = os.environ["API_ORIGIN"].rstrip("/") + path
headers = {}
headers["Authorization"] = "Bearer " + os.environ["AUTH_BEARERAUTH"]
headers["edid"] = "" + os.environ["AUTH_ACCOUNTCONTEXT"]
headers["Content-Type"] = "application/json"
body = "{\"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}}".encode("utf-8")

# 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="POST", data=body)
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.