/v2/layout/post/pdfPDF-Layout anlegen
Erstellt ein wiederverwendbares PDF-Layout. name, file_name, orientation und html sind erforderlich; orientation wird auf portrait oder landscape normalisiert. HTML und Dateiname können die über placeholders angebotenen Platzhalter verwenden. Seitenränder sind optional. data kann ein Objekt oder ein Array mit bis zu 100 Layouts enthalten.
Operation-ID post_v2_layout_post_pdf
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 · bearerExisting 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."
}accountContextapiKeySelected 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
sessionCookieapiKeyExisting 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."
}accountContextapiKeySelected 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."
}Parameter
Header
X-Edoobox-If-RevisionoptionalOptional account mutation revision from a preceding authenticated auth-context snapshot. The dispatcher compares it while holding the account lock; mismatch409 requires a new review.
- pattern
"^[a-f0-9]{32}$"
Schema-Beispiel
"aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"Vollständiges Schema als JSON
{
"type": "string",
"pattern": "^[a-f0-9]{32}$",
"examples": [
"aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
]
}Request Body
erforderlichapplication/json
data Typ nicht eingeschränkt erforderlich Single record or native API_DATA batch (1–100 records), with the same per-record required fields.
anyOf · Mindestens eine Variante muss passen
Variante 1 object PDF Structure fields. Canonical orientation values normalize; stored text limits are not rejecting JSON maxLength assertions.
id kein Wert zulässig status Typ nicht eingeschränkt Kanonischer Typ nach Normalisierung: boolean. Dies ist keine zusätzliche Einschränkung des Eingabetyps.
PHP coercion/normalization is applied by the Structure getter; its return type is not a rejecting wire-input type restriction.
Schema-Beispiel
falseFeld-Metadaten aus der Spezifikation
{
"x-edoobox-schemaStatus": "source-inferred",
"x-edoobox-sourceLine": 64,
"x-edoobox-canonicalType": "boolean",
"x-edoobox-normalization": "PHP coercion/normalization is applied by the Structure getter; its return type is not a rejecting wire-input type restriction."
}name Typ nicht eingeschränkt erforderlich bei Anlage erforderlich Internal PDF layout name; required on create.
Kanonischer Typ nach Normalisierung: string. Dies ist keine zusätzliche Einschränkung des Eingabetyps.
Maximal gespeicherte Länge: 150. Diese Speichergrenze ist keine maxLength-Validierung der Eingabe.
The aP getter trims text, replaces newlines and limits the legacy escaped storage representation to maxStoredLength UTF-8 characters without splitting escape pairs; aQ decodes the stored representation. Non-string input becomes empty text. This getter limit is normalization, not a rejecting input maxLength or proof of a custom action hook or database column capacity.
Schema-Beispiel
"Example"Feld-Metadaten aus der Spezifikation
{
"x-edoobox-canonicalType": "string",
"x-edoobox-maxStoredLength": 150,
"x-edoobox-normalization": "The aP getter trims text, replaces newlines and limits the legacy escaped storage representation to maxStoredLength UTF-8 characters without splitting escape pairs; aQ decodes the stored representation. Non-string input becomes empty text. This getter limit is normalization, not a rejecting input maxLength or proof of a custom action hook or database column capacity.",
"x-edoobox-requiredOnCreate": true,
"x-edoobox-sourceLine": 74
}file_name Typ nicht eingeschränkt erforderlich bei Anlage erforderlich Download filename template; may contain the account's supported PDF placeholders.
Kanonischer Typ nach Normalisierung: string. Dies ist keine zusätzliche Einschränkung des Eingabetyps.
Maximal gespeicherte Länge: 250. Diese Speichergrenze ist keine maxLength-Validierung der Eingabe.
The aP getter trims text, replaces newlines and limits the legacy escaped storage representation to maxStoredLength UTF-8 characters without splitting escape pairs; aQ decodes the stored representation. Non-string input becomes empty text. This getter limit is normalization, not a rejecting input maxLength or proof of a custom action hook or database column capacity.
Schema-Beispiel
"Example"Feld-Metadaten aus der Spezifikation
{
"x-edoobox-canonicalType": "string",
"x-edoobox-maxStoredLength": 250,
"x-edoobox-normalization": "The aP getter trims text, replaces newlines and limits the legacy escaped storage representation to maxStoredLength UTF-8 characters without splitting escape pairs; aQ decodes the stored representation. Non-string input becomes empty text. This getter limit is normalization, not a rejecting input maxLength or proof of a custom action hook or database column capacity.",
"x-edoobox-requiredOnCreate": true,
"x-edoobox-sourceLine": 88
}orientation Typ nicht eingeschränkt erforderlich bei Anlage erforderlich portrait or landscape is canonical; the getter normalizes other values to portrait.
Switch default normalizes other input values; case labels are not an exhaustive accepted-input enum.
Schema-Beispiel
"portrait"Feld-Metadaten aus der Spezifikation
{
"x-edoobox-knownInputs": [
"portrait",
"landscape"
],
"x-edoobox-normalization": "Switch default normalizes other input values; case labels are not an exhaustive accepted-input enum.",
"x-edoobox-requiredOnCreate": true,
"x-edoobox-sourceLine": 102
}page_first_margin Typ nicht eingeschränkt Native getter accepts any JSON input. Non-array input uses top=16, right=15, bottom=16, left=15. Array-like input is merged with those defaults; unknown keys are ignored and supplied values that fail is_numeric/value==intval(value) are removed. Kept values are stored as integers. This is normalization and filtering, not a rejecting input shape or integer-range assertion.
Schema-Beispiel
{
"top": 16,
"right": 15,
"bottom": 16,
"left": 15
}Feld-Metadaten aus der Spezifikation
{
"x-edoobox-schemaStatus": "source-reviewed-normalization",
"x-edoobox-sourceLine": 130
}page_next_margin Typ nicht eingeschränkt Native getter accepts any JSON input. Non-array input uses top=16, right=15, bottom=16, left=15. Array-like input is merged with those defaults; unknown keys are ignored and supplied values that fail is_numeric/value==intval(value) are removed. Kept values are stored as integers. This is normalization and filtering, not a rejecting input shape or integer-range assertion.
Schema-Beispiel
{
"top": 16,
"right": 15,
"bottom": 16,
"left": 15
}Feld-Metadaten aus der Spezifikation
{
"x-edoobox-schemaStatus": "source-reviewed-normalization",
"x-edoobox-sourceLine": 156
}html Typ nicht eingeschränkt erforderlich bei Anlage erforderlich HTML template rendered with the account's supported PDF placeholders.
Kanonischer Typ nach Normalisierung: string. Dies ist keine zusätzliche Einschränkung des Eingabetyps.
Maximal gespeicherte Länge: 60000. Diese Speichergrenze ist keine maxLength-Validierung der Eingabe.
The aP getter trims text, replaces newlines and limits the legacy escaped storage representation to maxStoredLength UTF-8 characters without splitting escape pairs; aQ decodes the stored representation. Non-string input becomes empty text. This getter limit is normalization, not a rejecting input maxLength or proof of a custom action hook or database column capacity.
Schema-Beispiel
"Example"Feld-Metadaten aus der Spezifikation
{
"x-edoobox-canonicalType": "string",
"x-edoobox-maxStoredLength": 60000,
"x-edoobox-normalization": "The aP getter trims text, replaces newlines and limits the legacy escaped storage representation to maxStoredLength UTF-8 characters without splitting escape pairs; aQ decodes the stored representation. Non-string input becomes empty text. This getter limit is normalization, not a rejecting input maxLength or proof of a custom action hook or database column capacity.",
"x-edoobox-requiredOnCreate": true,
"x-edoobox-sourceLine": 183
}last_change Typ nicht eingeschränkt beim Ändern nicht schreibbar The getter ignores submitted input and supplies the current server timestamp. No rejecting wire-input type is asserted.
Feld-Metadaten aus der Spezifikation
{
"x-edoobox-schemaStatus": "source-inferred",
"x-edoobox-serverValue": "time()",
"x-edoobox-writableOnUpdate": false,
"x-edoobox-sourceLine": 196
}Zusätzliche, hier nicht aufgeführte Felder sind erlaubt.
Variante 2 array - minItems
1- maxItems
100
Array-Elemente
PDF Structure fields. Canonical orientation values normalize; stored text limits are not rejecting JSON maxLength assertions.
id kein Wert zulässig status Typ nicht eingeschränkt Kanonischer Typ nach Normalisierung: boolean. Dies ist keine zusätzliche Einschränkung des Eingabetyps.
PHP coercion/normalization is applied by the Structure getter; its return type is not a rejecting wire-input type restriction.
Schema-Beispiel
falseFeld-Metadaten aus der Spezifikation
{
"x-edoobox-schemaStatus": "source-inferred",
"x-edoobox-sourceLine": 64,
"x-edoobox-canonicalType": "boolean",
"x-edoobox-normalization": "PHP coercion/normalization is applied by the Structure getter; its return type is not a rejecting wire-input type restriction."
}name Typ nicht eingeschränkt erforderlich bei Anlage erforderlich Internal PDF layout name; required on create.
Kanonischer Typ nach Normalisierung: string. Dies ist keine zusätzliche Einschränkung des Eingabetyps.
Maximal gespeicherte Länge: 150. Diese Speichergrenze ist keine maxLength-Validierung der Eingabe.
The aP getter trims text, replaces newlines and limits the legacy escaped storage representation to maxStoredLength UTF-8 characters without splitting escape pairs; aQ decodes the stored representation. Non-string input becomes empty text. This getter limit is normalization, not a rejecting input maxLength or proof of a custom action hook or database column capacity.
Schema-Beispiel
"Example"Feld-Metadaten aus der Spezifikation
{
"x-edoobox-canonicalType": "string",
"x-edoobox-maxStoredLength": 150,
"x-edoobox-normalization": "The aP getter trims text, replaces newlines and limits the legacy escaped storage representation to maxStoredLength UTF-8 characters without splitting escape pairs; aQ decodes the stored representation. Non-string input becomes empty text. This getter limit is normalization, not a rejecting input maxLength or proof of a custom action hook or database column capacity.",
"x-edoobox-requiredOnCreate": true,
"x-edoobox-sourceLine": 74
}file_name Typ nicht eingeschränkt erforderlich bei Anlage erforderlich Download filename template; may contain the account's supported PDF placeholders.
Kanonischer Typ nach Normalisierung: string. Dies ist keine zusätzliche Einschränkung des Eingabetyps.
Maximal gespeicherte Länge: 250. Diese Speichergrenze ist keine maxLength-Validierung der Eingabe.
The aP getter trims text, replaces newlines and limits the legacy escaped storage representation to maxStoredLength UTF-8 characters without splitting escape pairs; aQ decodes the stored representation. Non-string input becomes empty text. This getter limit is normalization, not a rejecting input maxLength or proof of a custom action hook or database column capacity.
Schema-Beispiel
"Example"Feld-Metadaten aus der Spezifikation
{
"x-edoobox-canonicalType": "string",
"x-edoobox-maxStoredLength": 250,
"x-edoobox-normalization": "The aP getter trims text, replaces newlines and limits the legacy escaped storage representation to maxStoredLength UTF-8 characters without splitting escape pairs; aQ decodes the stored representation. Non-string input becomes empty text. This getter limit is normalization, not a rejecting input maxLength or proof of a custom action hook or database column capacity.",
"x-edoobox-requiredOnCreate": true,
"x-edoobox-sourceLine": 88
}orientation Typ nicht eingeschränkt erforderlich bei Anlage erforderlich portrait or landscape is canonical; the getter normalizes other values to portrait.
Switch default normalizes other input values; case labels are not an exhaustive accepted-input enum.
Schema-Beispiel
"portrait"Feld-Metadaten aus der Spezifikation
{
"x-edoobox-knownInputs": [
"portrait",
"landscape"
],
"x-edoobox-normalization": "Switch default normalizes other input values; case labels are not an exhaustive accepted-input enum.",
"x-edoobox-requiredOnCreate": true,
"x-edoobox-sourceLine": 102
}page_first_margin Typ nicht eingeschränkt Native getter accepts any JSON input. Non-array input uses top=16, right=15, bottom=16, left=15. Array-like input is merged with those defaults; unknown keys are ignored and supplied values that fail is_numeric/value==intval(value) are removed. Kept values are stored as integers. This is normalization and filtering, not a rejecting input shape or integer-range assertion.
Schema-Beispiel
{
"top": 16,
"right": 15,
"bottom": 16,
"left": 15
}Feld-Metadaten aus der Spezifikation
{
"x-edoobox-schemaStatus": "source-reviewed-normalization",
"x-edoobox-sourceLine": 130
}page_next_margin Typ nicht eingeschränkt Native getter accepts any JSON input. Non-array input uses top=16, right=15, bottom=16, left=15. Array-like input is merged with those defaults; unknown keys are ignored and supplied values that fail is_numeric/value==intval(value) are removed. Kept values are stored as integers. This is normalization and filtering, not a rejecting input shape or integer-range assertion.
Schema-Beispiel
{
"top": 16,
"right": 15,
"bottom": 16,
"left": 15
}Feld-Metadaten aus der Spezifikation
{
"x-edoobox-schemaStatus": "source-reviewed-normalization",
"x-edoobox-sourceLine": 156
}html Typ nicht eingeschränkt erforderlich bei Anlage erforderlich HTML template rendered with the account's supported PDF placeholders.
Kanonischer Typ nach Normalisierung: string. Dies ist keine zusätzliche Einschränkung des Eingabetyps.
Maximal gespeicherte Länge: 60000. Diese Speichergrenze ist keine maxLength-Validierung der Eingabe.
The aP getter trims text, replaces newlines and limits the legacy escaped storage representation to maxStoredLength UTF-8 characters without splitting escape pairs; aQ decodes the stored representation. Non-string input becomes empty text. This getter limit is normalization, not a rejecting input maxLength or proof of a custom action hook or database column capacity.
Schema-Beispiel
"Example"Feld-Metadaten aus der Spezifikation
{
"x-edoobox-canonicalType": "string",
"x-edoobox-maxStoredLength": 60000,
"x-edoobox-normalization": "The aP getter trims text, replaces newlines and limits the legacy escaped storage representation to maxStoredLength UTF-8 characters without splitting escape pairs; aQ decodes the stored representation. Non-string input becomes empty text. This getter limit is normalization, not a rejecting input maxLength or proof of a custom action hook or database column capacity.",
"x-edoobox-requiredOnCreate": true,
"x-edoobox-sourceLine": 183
}last_change Typ nicht eingeschränkt beim Ändern nicht schreibbar The getter ignores submitted input and supplies the current server timestamp. No rejecting wire-input type is asserted.
Feld-Metadaten aus der Spezifikation
{
"x-edoobox-schemaStatus": "source-inferred",
"x-edoobox-serverValue": "time()",
"x-edoobox-writableOnUpdate": false,
"x-edoobox-sourceLine": 196
}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",
"required": [
"data"
],
"properties": {
"data": {
"anyOf": [
{
"type": "object",
"properties": {
"id": false,
"status": {
"x-edoobox-schemaStatus": "source-inferred",
"x-edoobox-sourceLine": 64,
"x-edoobox-canonicalType": "boolean",
"x-edoobox-normalization": "PHP coercion/normalization is applied by the Structure getter; its return type is not a rejecting wire-input type restriction.",
"examples": [
false
]
},
"name": {
"x-edoobox-canonicalType": "string",
"x-edoobox-maxStoredLength": 150,
"x-edoobox-normalization": "The aP getter trims text, replaces newlines and limits the legacy escaped storage representation to maxStoredLength UTF-8 characters without splitting escape pairs; aQ decodes the stored representation. Non-string input becomes empty text. This getter limit is normalization, not a rejecting input maxLength or proof of a custom action hook or database column capacity.",
"examples": [
"Example"
],
"x-edoobox-requiredOnCreate": true,
"x-edoobox-sourceLine": 74,
"description": "Internal PDF layout name; required on create."
},
"file_name": {
"x-edoobox-canonicalType": "string",
"x-edoobox-maxStoredLength": 250,
"x-edoobox-normalization": "The aP getter trims text, replaces newlines and limits the legacy escaped storage representation to maxStoredLength UTF-8 characters without splitting escape pairs; aQ decodes the stored representation. Non-string input becomes empty text. This getter limit is normalization, not a rejecting input maxLength or proof of a custom action hook or database column capacity.",
"examples": [
"Example"
],
"x-edoobox-requiredOnCreate": true,
"x-edoobox-sourceLine": 88,
"description": "Download filename template; may contain the account's supported PDF placeholders."
},
"orientation": {
"x-edoobox-knownInputs": [
"portrait",
"landscape"
],
"x-edoobox-normalization": "Switch default normalizes other input values; case labels are not an exhaustive accepted-input enum.",
"examples": [
"portrait"
],
"x-edoobox-requiredOnCreate": true,
"x-edoobox-sourceLine": 102,
"description": "portrait or landscape is canonical; the getter normalizes other values to portrait."
},
"page_first_margin": {
"x-edoobox-schemaStatus": "source-reviewed-normalization",
"description": "Native getter accepts any JSON input. Non-array input uses top=16, right=15, bottom=16, left=15. Array-like input is merged with those defaults; unknown keys are ignored and supplied values that fail is_numeric/value==intval(value) are removed. Kept values are stored as integers. This is normalization and filtering, not a rejecting input shape or integer-range assertion.",
"examples": [
{
"top": 16,
"right": 15,
"bottom": 16,
"left": 15
}
],
"x-edoobox-sourceLine": 130
},
"page_next_margin": {
"x-edoobox-schemaStatus": "source-reviewed-normalization",
"description": "Native getter accepts any JSON input. Non-array input uses top=16, right=15, bottom=16, left=15. Array-like input is merged with those defaults; unknown keys are ignored and supplied values that fail is_numeric/value==intval(value) are removed. Kept values are stored as integers. This is normalization and filtering, not a rejecting input shape or integer-range assertion.",
"examples": [
{
"top": 16,
"right": 15,
"bottom": 16,
"left": 15
}
],
"x-edoobox-sourceLine": 156
},
"html": {
"x-edoobox-canonicalType": "string",
"x-edoobox-maxStoredLength": 60000,
"x-edoobox-normalization": "The aP getter trims text, replaces newlines and limits the legacy escaped storage representation to maxStoredLength UTF-8 characters without splitting escape pairs; aQ decodes the stored representation. Non-string input becomes empty text. This getter limit is normalization, not a rejecting input maxLength or proof of a custom action hook or database column capacity.",
"examples": [
"Example"
],
"x-edoobox-requiredOnCreate": true,
"x-edoobox-sourceLine": 183,
"description": "HTML template rendered with the account's supported PDF placeholders."
},
"last_change": {
"x-edoobox-schemaStatus": "source-inferred",
"x-edoobox-serverValue": "time()",
"description": "The getter ignores submitted input and supplies the current server timestamp. No rejecting wire-input type is asserted.",
"x-edoobox-writableOnUpdate": false,
"x-edoobox-sourceLine": 196
}
},
"additionalProperties": true,
"description": "PDF Structure fields. Canonical orientation values normalize; stored text limits are not rejecting JSON maxLength assertions.",
"required": [
"name",
"file_name",
"orientation",
"html"
]
},
{
"type": "array",
"minItems": 1,
"maxItems": 100,
"items": {
"type": "object",
"properties": {
"id": false,
"status": {
"x-edoobox-schemaStatus": "source-inferred",
"x-edoobox-sourceLine": 64,
"x-edoobox-canonicalType": "boolean",
"x-edoobox-normalization": "PHP coercion/normalization is applied by the Structure getter; its return type is not a rejecting wire-input type restriction.",
"examples": [
false
]
},
"name": {
"x-edoobox-canonicalType": "string",
"x-edoobox-maxStoredLength": 150,
"x-edoobox-normalization": "The aP getter trims text, replaces newlines and limits the legacy escaped storage representation to maxStoredLength UTF-8 characters without splitting escape pairs; aQ decodes the stored representation. Non-string input becomes empty text. This getter limit is normalization, not a rejecting input maxLength or proof of a custom action hook or database column capacity.",
"examples": [
"Example"
],
"x-edoobox-requiredOnCreate": true,
"x-edoobox-sourceLine": 74,
"description": "Internal PDF layout name; required on create."
},
"file_name": {
"x-edoobox-canonicalType": "string",
"x-edoobox-maxStoredLength": 250,
"x-edoobox-normalization": "The aP getter trims text, replaces newlines and limits the legacy escaped storage representation to maxStoredLength UTF-8 characters without splitting escape pairs; aQ decodes the stored representation. Non-string input becomes empty text. This getter limit is normalization, not a rejecting input maxLength or proof of a custom action hook or database column capacity.",
"examples": [
"Example"
],
"x-edoobox-requiredOnCreate": true,
"x-edoobox-sourceLine": 88,
"description": "Download filename template; may contain the account's supported PDF placeholders."
},
"orientation": {
"x-edoobox-knownInputs": [
"portrait",
"landscape"
],
"x-edoobox-normalization": "Switch default normalizes other input values; case labels are not an exhaustive accepted-input enum.",
"examples": [
"portrait"
],
"x-edoobox-requiredOnCreate": true,
"x-edoobox-sourceLine": 102,
"description": "portrait or landscape is canonical; the getter normalizes other values to portrait."
},
"page_first_margin": {
"x-edoobox-schemaStatus": "source-reviewed-normalization",
"description": "Native getter accepts any JSON input. Non-array input uses top=16, right=15, bottom=16, left=15. Array-like input is merged with those defaults; unknown keys are ignored and supplied values that fail is_numeric/value==intval(value) are removed. Kept values are stored as integers. This is normalization and filtering, not a rejecting input shape or integer-range assertion.",
"examples": [
{
"top": 16,
"right": 15,
"bottom": 16,
"left": 15
}
],
"x-edoobox-sourceLine": 130
},
"page_next_margin": {
"x-edoobox-schemaStatus": "source-reviewed-normalization",
"description": "Native getter accepts any JSON input. Non-array input uses top=16, right=15, bottom=16, left=15. Array-like input is merged with those defaults; unknown keys are ignored and supplied values that fail is_numeric/value==intval(value) are removed. Kept values are stored as integers. This is normalization and filtering, not a rejecting input shape or integer-range assertion.",
"examples": [
{
"top": 16,
"right": 15,
"bottom": 16,
"left": 15
}
],
"x-edoobox-sourceLine": 156
},
"html": {
"x-edoobox-canonicalType": "string",
"x-edoobox-maxStoredLength": 60000,
"x-edoobox-normalization": "The aP getter trims text, replaces newlines and limits the legacy escaped storage representation to maxStoredLength UTF-8 characters without splitting escape pairs; aQ decodes the stored representation. Non-string input becomes empty text. This getter limit is normalization, not a rejecting input maxLength or proof of a custom action hook or database column capacity.",
"examples": [
"Example"
],
"x-edoobox-requiredOnCreate": true,
"x-edoobox-sourceLine": 183,
"description": "HTML template rendered with the account's supported PDF placeholders."
},
"last_change": {
"x-edoobox-schemaStatus": "source-inferred",
"x-edoobox-serverValue": "time()",
"description": "The getter ignores submitted input and supplies the current server timestamp. No rejecting wire-input type is asserted.",
"x-edoobox-writableOnUpdate": false,
"x-edoobox-sourceLine": 196
}
},
"additionalProperties": true,
"description": "PDF Structure fields. Canonical orientation values normalize; stored text limits are not rejecting JSON maxLength assertions.",
"required": [
"name",
"file_name",
"orientation",
"html"
]
}
}
],
"description": "Single record or native API_DATA batch (1–100 records), with the same per-record required fields."
}
},
"additionalProperties": true
}Synthetic supported request; replace all IDs with values read from this account.
{
"data": {
"name": "Example layout",
"file_name": "Example_##OfferName##",
"orientation": "portrait",
"html": "<p>##OfferName##</p>"
}
}Synthetic supported request; replace all IDs with values read from this account.
{
"data": [
{
"name": "Example layout",
"file_name": "Example_##OfferName##",
"orientation": "portrait",
"html": "<p>##OfferName##</p>"
},
{
"name": "Second example",
"file_name": "Example_##OfferName##",
"orientation": "portrait",
"html": "<p>##OfferName##</p>"
}
]
}Antworten
11HTTP-Status und Antwortinhalt gemeinsam auswerten. In dieser API können auch Antworten mit HTTP 200 einen Fehler enthalten.
200application/json
data enthält insert und id; bei einem Datensatz ist id eine öffentliche v2-ID, beim Batch ein Array solcher IDs. Bei fehlgeschlagenem Transaktionsabschluss enthält data insert=false und id=null; error ist ED80100.
Response Header
X-Edoobox-Revision
Rotated account revision supplied for the next action in one reviewed sequence.
- pattern
"^[a-f0-9]{32}$"
Vollständiges Schema als JSON
{
"type": "string",
"pattern": "^[a-f0-9]{32}$"
}application/json
success boolean error boolean | string error_code string data object insert boolean erforderlich id Typ nicht eingeschränkt erforderlich Bei erfolgreichem Einzelinsert öffentliche v2-ID, bei erfolgreichem Batch ein Array öffentlicher IDs; bei fehlgeschlagenem Transaktionsabschluss null zusammen mit insert=false und error=ED80100.
oneOf · Genau eine Variante muss passen
Variante 1 string Öffentliche v2-ID aus diesem Konto; keine Datenbank-ID. Beispiel ist synthetisch.
- pattern
"^layoutpdf_[a-f0-9]{12}_-?[0-9]+$"
Schema-Beispiel
"layoutpdf_012345abcdef_123456"Variante 2 array Array-Elemente
Öffentliche v2-ID aus diesem Konto; keine Datenbank-ID. Beispiel ist synthetisch.
- pattern
"^layoutpdf_[a-f0-9]{12}_-?[0-9]+$"
Schema-Beispiel
"layoutpdf_012345abcdef_123456"Variante 3 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": {
"insert": {
"type": "boolean"
},
"id": {
"oneOf": [
{
"type": "string",
"pattern": "^layoutpdf_[a-f0-9]{12}_-?[0-9]+$",
"description": "Öffentliche v2-ID aus diesem Konto; keine Datenbank-ID. Beispiel ist synthetisch.",
"examples": [
"layoutpdf_012345abcdef_123456"
]
},
{
"type": "array",
"items": {
"type": "string",
"pattern": "^layoutpdf_[a-f0-9]{12}_-?[0-9]+$",
"description": "Öffentliche v2-ID aus diesem Konto; keine Datenbank-ID. Beispiel ist synthetisch.",
"examples": [
"layoutpdf_012345abcdef_123456"
]
}
},
{
"type": "null"
}
],
"description": "Bei erfolgreichem Einzelinsert öffentliche v2-ID, bei erfolgreichem Batch ein Array öffentlicher IDs; bei fehlgeschlagenem Transaktionsabschluss null zusammen mit insert=false und error=ED80100."
}
},
"additionalProperties": true,
"required": [
"id",
"insert"
]
},
"type": {
"type": "string"
}
},
"additionalProperties": true
}created
{
"error": false,
"data": {
"insert": true,
"id": "layoutpdf_012345abcdef_123456"
}
}createdBatch
{
"error": false,
"data": {
"insert": true,
"id": [
"layoutpdf_012345abcdef_123456",
"layoutpdf_012345abcdef_123457"
]
}
}commitFailure
{
"error": "ED80100",
"data": {
"insert": false,
"id": null
}
}reviewed
{
"error": false,
"data": {
"id": "layoutpdf_012345abcdef_123456",
"insert": true
}
}400application/json
Invalid request.
application/json
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
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
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
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
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
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
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.
Schema-Beispiel
"30"Vollständiges Schema als JSON
{
"type": "string",
"examples": [
"30"
]
}application/json
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
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
Fester Wert: 1
Vollständiges Schema als JSON
{
"type": "integer",
"const": 1
}application/json
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
application/models/v2/Layout.php:496postLayout()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
truex-edoobox-routeAliasEvidence
{
"file": "application/models/v2/Layout.php",
"line": 500,
"reason": "postLayout chooses segment4 Structure and ignores segment3; Vue uses literal post.",
"sha256": "d5bf4faf862da921710d9d2f553b14778a2b78eb8281a2f195dd5d52f9886eaf",
"method": "postLayout"
}x-edoobox-action-contract
{
"review": "layout-pdf-post",
"status": "source-reviewed-partial",
"sources": [
{
"file": "application/models/v2/Layout.php",
"sha256": "d5bf4faf862da921710d9d2f553b14778a2b78eb8281a2f195dd5d52f9886eaf",
"methods": [
"__construct",
"setStructure_PDF",
"postLayout",
"updateLayout"
]
},
{
"file": "application/models/v2/API_DATA.php",
"sha256": "c0e15d26a7a4f3fb3c25e35557d4420ad395b2af3925caec292de08e32ebf44c",
"methods": [
"return_insert_data",
"return_update_data"
]
}
],
"preconditions": [
"Only the selected account owns or changes the layout; placeholder and template expansion use native account context."
],
"errors": [
{
"error": "ED80100",
"meaning": "Required create fields, rejected getter value, or native write validation failed."
},
{
"error": "ED80023",
"meaning": "Generic batch create exceeds 100 records."
}
],
"unresolved": [
"Template placeholders, account data, signed ID integrity and rendering output remain native. Scalar getter coercion is documented without inventing rejecting wire limits."
]
}x-edoobox-runtimeMutationGuard
truex-edoobox-documentationReview
{
"file": "docs/openapi/operation-contracts/07-layout-files.json",
"notes": []
}x-edoobox-source
{
"file": "application/models/v2/Layout.php",
"method": "postLayout",
"line": 496
}x-edoobox-documentationStatus
"reviewed"x-edoobox-readOnly
falsex-edoobox-safeForAutomation
falsex-edoobox-permission
{
"resource": "layout",
"short": "lyot",
"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_layout_post_pdf",
"summary": "PDF-Layout anlegen",
"description": "Erstellt ein wiederverwendbares PDF-Layout. name, file_name, orientation und html sind erforderlich; orientation wird auf portrait oder landscape normalisiert. HTML und Dateiname können die über placeholders angebotenen Platzhalter verwenden. Seitenränder sind optional. data kann ein Objekt oder ein Array mit bis zu 100 Layouts enthalten.",
"tags": [
"layout"
],
"security": [
{
"bearerAuth": [],
"accountContext": []
},
{
"sessionCookie": [],
"accountContext": []
}
],
"parameters": [
{
"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": "data enthält insert und id; bei einem Datensatz ist id eine öffentliche v2-ID, beim Batch ein Array solcher IDs. Bei fehlgeschlagenem Transaktionsabschluss enthält data insert=false und id=null; error ist ED80100.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"success": {
"type": "boolean"
},
"error": {
"type": [
"boolean",
"string"
]
},
"error_code": {
"type": "string"
},
"data": {
"type": "object",
"properties": {
"insert": {
"type": "boolean"
},
"id": {
"oneOf": [
{
"type": "string",
"pattern": "^layoutpdf_[a-f0-9]{12}_-?[0-9]+$",
"description": "Öffentliche v2-ID aus diesem Konto; keine Datenbank-ID. Beispiel ist synthetisch.",
"examples": [
"layoutpdf_012345abcdef_123456"
]
},
{
"type": "array",
"items": {
"type": "string",
"pattern": "^layoutpdf_[a-f0-9]{12}_-?[0-9]+$",
"description": "Öffentliche v2-ID aus diesem Konto; keine Datenbank-ID. Beispiel ist synthetisch.",
"examples": [
"layoutpdf_012345abcdef_123456"
]
}
},
{
"type": "null"
}
],
"description": "Bei erfolgreichem Einzelinsert öffentliche v2-ID, bei erfolgreichem Batch ein Array öffentlicher IDs; bei fehlgeschlagenem Transaktionsabschluss null zusammen mit insert=false und error=ED80100."
}
},
"additionalProperties": true,
"required": [
"id",
"insert"
]
},
"type": {
"type": "string"
}
},
"additionalProperties": true
},
"examples": {
"created": {
"value": {
"error": false,
"data": {
"insert": true,
"id": "layoutpdf_012345abcdef_123456"
}
}
},
"createdBatch": {
"value": {
"error": false,
"data": {
"insert": true,
"id": [
"layoutpdf_012345abcdef_123456",
"layoutpdf_012345abcdef_123457"
]
}
}
},
"commitFailure": {
"value": {
"error": "ED80100",
"data": {
"insert": false,
"id": null
}
}
},
"reviewed": {
"value": {
"error": false,
"data": {
"id": "layoutpdf_012345abcdef_123456",
"insert": 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",
"required": [
"data"
],
"properties": {
"data": {
"anyOf": [
{
"type": "object",
"properties": {
"id": false,
"status": {
"x-edoobox-schemaStatus": "source-inferred",
"x-edoobox-sourceLine": 64,
"x-edoobox-canonicalType": "boolean",
"x-edoobox-normalization": "PHP coercion/normalization is applied by the Structure getter; its return type is not a rejecting wire-input type restriction.",
"examples": [
false
]
},
"name": {
"x-edoobox-canonicalType": "string",
"x-edoobox-maxStoredLength": 150,
"x-edoobox-normalization": "The aP getter trims text, replaces newlines and limits the legacy escaped storage representation to maxStoredLength UTF-8 characters without splitting escape pairs; aQ decodes the stored representation. Non-string input becomes empty text. This getter limit is normalization, not a rejecting input maxLength or proof of a custom action hook or database column capacity.",
"examples": [
"Example"
],
"x-edoobox-requiredOnCreate": true,
"x-edoobox-sourceLine": 74,
"description": "Internal PDF layout name; required on create."
},
"file_name": {
"x-edoobox-canonicalType": "string",
"x-edoobox-maxStoredLength": 250,
"x-edoobox-normalization": "The aP getter trims text, replaces newlines and limits the legacy escaped storage representation to maxStoredLength UTF-8 characters without splitting escape pairs; aQ decodes the stored representation. Non-string input becomes empty text. This getter limit is normalization, not a rejecting input maxLength or proof of a custom action hook or database column capacity.",
"examples": [
"Example"
],
"x-edoobox-requiredOnCreate": true,
"x-edoobox-sourceLine": 88,
"description": "Download filename template; may contain the account's supported PDF placeholders."
},
"orientation": {
"x-edoobox-knownInputs": [
"portrait",
"landscape"
],
"x-edoobox-normalization": "Switch default normalizes other input values; case labels are not an exhaustive accepted-input enum.",
"examples": [
"portrait"
],
"x-edoobox-requiredOnCreate": true,
"x-edoobox-sourceLine": 102,
"description": "portrait or landscape is canonical; the getter normalizes other values to portrait."
},
"page_first_margin": {
"x-edoobox-schemaStatus": "source-reviewed-normalization",
"description": "Native getter accepts any JSON input. Non-array input uses top=16, right=15, bottom=16, left=15. Array-like input is merged with those defaults; unknown keys are ignored and supplied values that fail is_numeric/value==intval(value) are removed. Kept values are stored as integers. This is normalization and filtering, not a rejecting input shape or integer-range assertion.",
"examples": [
{
"top": 16,
"right": 15,
"bottom": 16,
"left": 15
}
],
"x-edoobox-sourceLine": 130
},
"page_next_margin": {
"x-edoobox-schemaStatus": "source-reviewed-normalization",
"description": "Native getter accepts any JSON input. Non-array input uses top=16, right=15, bottom=16, left=15. Array-like input is merged with those defaults; unknown keys are ignored and supplied values that fail is_numeric/value==intval(value) are removed. Kept values are stored as integers. This is normalization and filtering, not a rejecting input shape or integer-range assertion.",
"examples": [
{
"top": 16,
"right": 15,
"bottom": 16,
"left": 15
}
],
"x-edoobox-sourceLine": 156
},
"html": {
"x-edoobox-canonicalType": "string",
"x-edoobox-maxStoredLength": 60000,
"x-edoobox-normalization": "The aP getter trims text, replaces newlines and limits the legacy escaped storage representation to maxStoredLength UTF-8 characters without splitting escape pairs; aQ decodes the stored representation. Non-string input becomes empty text. This getter limit is normalization, not a rejecting input maxLength or proof of a custom action hook or database column capacity.",
"examples": [
"Example"
],
"x-edoobox-requiredOnCreate": true,
"x-edoobox-sourceLine": 183,
"description": "HTML template rendered with the account's supported PDF placeholders."
},
"last_change": {
"x-edoobox-schemaStatus": "source-inferred",
"x-edoobox-serverValue": "time()",
"description": "The getter ignores submitted input and supplies the current server timestamp. No rejecting wire-input type is asserted.",
"x-edoobox-writableOnUpdate": false,
"x-edoobox-sourceLine": 196
}
},
"additionalProperties": true,
"description": "PDF Structure fields. Canonical orientation values normalize; stored text limits are not rejecting JSON maxLength assertions.",
"required": [
"name",
"file_name",
"orientation",
"html"
]
},
{
"type": "array",
"minItems": 1,
"maxItems": 100,
"items": {
"type": "object",
"properties": {
"id": false,
"status": {
"x-edoobox-schemaStatus": "source-inferred",
"x-edoobox-sourceLine": 64,
"x-edoobox-canonicalType": "boolean",
"x-edoobox-normalization": "PHP coercion/normalization is applied by the Structure getter; its return type is not a rejecting wire-input type restriction.",
"examples": [
false
]
},
"name": {
"x-edoobox-canonicalType": "string",
"x-edoobox-maxStoredLength": 150,
"x-edoobox-normalization": "The aP getter trims text, replaces newlines and limits the legacy escaped storage representation to maxStoredLength UTF-8 characters without splitting escape pairs; aQ decodes the stored representation. Non-string input becomes empty text. This getter limit is normalization, not a rejecting input maxLength or proof of a custom action hook or database column capacity.",
"examples": [
"Example"
],
"x-edoobox-requiredOnCreate": true,
"x-edoobox-sourceLine": 74,
"description": "Internal PDF layout name; required on create."
},
"file_name": {
"x-edoobox-canonicalType": "string",
"x-edoobox-maxStoredLength": 250,
"x-edoobox-normalization": "The aP getter trims text, replaces newlines and limits the legacy escaped storage representation to maxStoredLength UTF-8 characters without splitting escape pairs; aQ decodes the stored representation. Non-string input becomes empty text. This getter limit is normalization, not a rejecting input maxLength or proof of a custom action hook or database column capacity.",
"examples": [
"Example"
],
"x-edoobox-requiredOnCreate": true,
"x-edoobox-sourceLine": 88,
"description": "Download filename template; may contain the account's supported PDF placeholders."
},
"orientation": {
"x-edoobox-knownInputs": [
"portrait",
"landscape"
],
"x-edoobox-normalization": "Switch default normalizes other input values; case labels are not an exhaustive accepted-input enum.",
"examples": [
"portrait"
],
"x-edoobox-requiredOnCreate": true,
"x-edoobox-sourceLine": 102,
"description": "portrait or landscape is canonical; the getter normalizes other values to portrait."
},
"page_first_margin": {
"x-edoobox-schemaStatus": "source-reviewed-normalization",
"description": "Native getter accepts any JSON input. Non-array input uses top=16, right=15, bottom=16, left=15. Array-like input is merged with those defaults; unknown keys are ignored and supplied values that fail is_numeric/value==intval(value) are removed. Kept values are stored as integers. This is normalization and filtering, not a rejecting input shape or integer-range assertion.",
"examples": [
{
"top": 16,
"right": 15,
"bottom": 16,
"left": 15
}
],
"x-edoobox-sourceLine": 130
},
"page_next_margin": {
"x-edoobox-schemaStatus": "source-reviewed-normalization",
"description": "Native getter accepts any JSON input. Non-array input uses top=16, right=15, bottom=16, left=15. Array-like input is merged with those defaults; unknown keys are ignored and supplied values that fail is_numeric/value==intval(value) are removed. Kept values are stored as integers. This is normalization and filtering, not a rejecting input shape or integer-range assertion.",
"examples": [
{
"top": 16,
"right": 15,
"bottom": 16,
"left": 15
}
],
"x-edoobox-sourceLine": 156
},
"html": {
"x-edoobox-canonicalType": "string",
"x-edoobox-maxStoredLength": 60000,
"x-edoobox-normalization": "The aP getter trims text, replaces newlines and limits the legacy escaped storage representation to maxStoredLength UTF-8 characters without splitting escape pairs; aQ decodes the stored representation. Non-string input becomes empty text. This getter limit is normalization, not a rejecting input maxLength or proof of a custom action hook or database column capacity.",
"examples": [
"Example"
],
"x-edoobox-requiredOnCreate": true,
"x-edoobox-sourceLine": 183,
"description": "HTML template rendered with the account's supported PDF placeholders."
},
"last_change": {
"x-edoobox-schemaStatus": "source-inferred",
"x-edoobox-serverValue": "time()",
"description": "The getter ignores submitted input and supplies the current server timestamp. No rejecting wire-input type is asserted.",
"x-edoobox-writableOnUpdate": false,
"x-edoobox-sourceLine": 196
}
},
"additionalProperties": true,
"description": "PDF Structure fields. Canonical orientation values normalize; stored text limits are not rejecting JSON maxLength assertions.",
"required": [
"name",
"file_name",
"orientation",
"html"
]
}
}
],
"description": "Single record or native API_DATA batch (1–100 records), with the same per-record required fields."
}
},
"additionalProperties": true
},
"examples": {
"single": {
"summary": "Synthetic supported request; replace all IDs with values read from this account.",
"value": {
"data": {
"name": "Example layout",
"file_name": "Example_##OfferName##",
"orientation": "portrait",
"html": "<p>##OfferName##</p>"
}
}
},
"batch": {
"summary": "Synthetic supported request; replace all IDs with values read from this account.",
"value": {
"data": [
{
"name": "Example layout",
"file_name": "Example_##OfferName##",
"orientation": "portrait",
"html": "<p>##OfferName##</p>"
},
{
"name": "Second example",
"file_name": "Example_##OfferName##",
"orientation": "portrait",
"html": "<p>##OfferName##</p>"
}
]
}
}
}
}
}
},
"x-edoobox-routeAliasEvidence": {
"file": "application/models/v2/Layout.php",
"line": 500,
"reason": "postLayout chooses segment4 Structure and ignores segment3; Vue uses literal post.",
"sha256": "d5bf4faf862da921710d9d2f553b14778a2b78eb8281a2f195dd5d52f9886eaf",
"method": "postLayout"
},
"x-edoobox-action-contract": {
"review": "layout-pdf-post",
"status": "source-reviewed-partial",
"sources": [
{
"file": "application/models/v2/Layout.php",
"sha256": "d5bf4faf862da921710d9d2f553b14778a2b78eb8281a2f195dd5d52f9886eaf",
"methods": [
"__construct",
"setStructure_PDF",
"postLayout",
"updateLayout"
]
},
{
"file": "application/models/v2/API_DATA.php",
"sha256": "c0e15d26a7a4f3fb3c25e35557d4420ad395b2af3925caec292de08e32ebf44c",
"methods": [
"return_insert_data",
"return_update_data"
]
}
],
"preconditions": [
"Only the selected account owns or changes the layout; placeholder and template expansion use native account context."
],
"errors": [
{
"error": "ED80100",
"meaning": "Required create fields, rejected getter value, or native write validation failed."
},
{
"error": "ED80023",
"meaning": "Generic batch create exceeds 100 records."
}
],
"unresolved": [
"Template placeholders, account data, signed ID integrity and rendering output remain native. Scalar getter coercion is documented without inventing rejecting wire limits."
]
},
"x-edoobox-runtimeMutationGuard": true,
"x-edoobox-documentationReview": {
"file": "docs/openapi/operation-contracts/07-layout-files.json",
"notes": []
},
"x-edoobox-source": {
"file": "application/models/v2/Layout.php",
"method": "postLayout",
"line": 496
},
"x-edoobox-documentationStatus": "reviewed",
"x-edoobox-readOnly": false,
"x-edoobox-safeForAutomation": false,
"x-edoobox-permission": {
"resource": "layout",
"short": "lyot",
"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."
}
}