PDF-Layout ändern

{
  "operationId": "put_v2_layout_id_pdf",
  "summary": "PDF-Layout ändern",
  "description": "Ändert einzelne Einstellungen des PDF-Layouts, z.B. Name, HTML, Dateinamenmuster, Ausrichtung oder Seitenränder. Nicht übergebene Felder bleiben erhalten. Ein nicht leeres data mit einem beschreibbaren Feld ist erforderlich.",
  "tags": [
    "layout"
  ],
  "security": [
    {
      "bearerAuth": [],
      "accountContext": []
    },
    {
      "sessionCookie": [],
      "accountContext": []
    }
  ],
  "parameters": [
    {
      "name": "id",
      "in": "path",
      "required": true,
      "description": "Öffentliche v2-ID des ausgewählten Objekts.",
      "schema": {
        "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"
        ]
      }
    },
    {
      "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.id und update melden, ob das ausgewählte Layout geändert wurde.",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "properties": {
              "success": {
                "type": "boolean"
              },
              "error": {
                "type": [
                  "boolean",
                  "string"
                ]
              },
              "error_code": {
                "type": "string"
              },
              "data": {
                "type": "object",
                "properties": {
                  "id": {
                    "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"
                    ]
                  },
                  "update": {
                    "type": "boolean"
                  }
                },
                "additionalProperties": true,
                "required": [
                  "id",
                  "update"
                ]
              },
              "type": {
                "type": "string"
              }
            },
            "additionalProperties": true
          },
          "examples": {
            "updated": {
              "value": {
                "error": false,
                "data": {
                  "update": true,
                  "id": "layoutpdf_012345abcdef_123456"
                }
              }
            },
            "reviewed": {
              "value": {
                "error": false,
                "data": {
                  "id": "layoutpdf_012345abcdef_123456",
                  "update": 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": {
              "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": false
              },
              "additionalProperties": true,
              "description": "PDF Structure fields. Canonical orientation values normalize; stored text limits are not rejecting JSON maxLength assertions."
            }
          },
          "additionalProperties": true
        },
        "examples": {
          "rename": {
            "summary": "Synthetic supported request; replace all IDs with values read from this account.",
            "value": {
              "data": {
                "name": "Renamed layout"
              }
            }
          }
        }
      }
    }
  },
  "x-edoobox-action-contract": {
    "review": "layout-pdf-put",
    "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": "updateLayout",
    "line": 531
  },
  "x-edoobox-documentationStatus": "reviewed",
  "x-edoobox-readOnly": false,
  "x-edoobox-safeForAutomation": false,
  "x-edoobox-permission": {
    "resource": "layout",
    "short": "lyot",
    "checkedByDispatcher": true,
    "levels": [
      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."
  }
}