/v2/emailtemplate/{id}/pdf_template_urlSignierte Lese-URL einer Vorlagendatei abrufen
Liefert Metadaten und eine signierte Lese-URL für einen bereits verifizierten Anhang oder PDF-Hintergrund des Kontos. Die ID bezeichnet attachment_ oder pdftemplate_. Die Aktion lädt keine Datei hoch und ändert keine Vorlagen. Die öffentliche Datei-ID im Pfad wird als ID-Filter verwendet.
Operation-ID get_v2_emailtemplate_id_pdf_template_url
Vertrag & Verhalten
- Dokumentationsstand
- reviewed
- Ändert Zustand
- Nein
- Als readOnly markiert
- Ja
- Für Automation markiert
- Nein
read
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
Query-Parameter
filteroptionalJSON-encoded filter value consumed by RequestAPIData / API_DATA; specific actions may ignore it.
application/json
Schema-Beispiel
[
{
"property": "id",
"expression": "=",
"value": "emailtemplate_012345abcdef_123456"
}
]Array-Elemente
property string expression string value Typ nicht eingeschränkt Zusätzliche, hier nicht aufgeführte Felder sind erlaubt.
Vollständiges Schema als JSON
{
"type": "array",
"items": {
"type": "object",
"properties": {
"property": {
"type": "string"
},
"expression": {
"type": "string"
},
"value": {}
},
"additionalProperties": true
},
"examples": [
[
{
"property": "id",
"expression": "=",
"value": "emailtemplate_012345abcdef_123456"
}
]
]
}Beispiel
[
{
"property": "id",
"expression": "=",
"value": "emailtemplate_012345abcdef_123456"
}
]Header
languageoptionalAccount language code, where the resource supports setLanguage().
Schema-Beispiel
"de"Vollständiges Schema als JSON
{
"type": "string",
"examples": [
"de"
]
}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"
]
}Pfadparameter
iderforderlichÖffentliche Datei-ID.
anyOf · Mindestens eine Variante muss passen
Variante 1 string Öffentliche v2-ID aus dem ausgewählten Konto; keine interne Datenbank-ID.
- pattern
"^attachment_[a-f0-9]{12}_-?[0-9]+$"
Variante 2 string Öffentliche v2-ID aus dem ausgewählten Konto; keine interne Datenbank-ID.
- pattern
"^pdftemplate_[a-f0-9]{12}_-?[0-9]+$"
Vollständiges Schema als JSON
{
"anyOf": [
{
"type": "string",
"pattern": "^attachment_[a-f0-9]{12}_-?[0-9]+$",
"description": "Öffentliche v2-ID aus dem ausgewählten Konto; keine interne Datenbank-ID."
},
{
"type": "string",
"pattern": "^pdftemplate_[a-f0-9]{12}_-?[0-9]+$",
"description": "Öffentliche v2-ID aus dem ausgewählten Konto; keine interne Datenbank-ID."
}
]
}Request Body
Kein Request Body in der Spezifikation beschrieben.
Antworten
11HTTP-Status und Antwortinhalt gemeinsam auswerten. In dieser API können auch Antworten mit HTTP 200 einen Fehler enthalten.
200application/json
Nach öffentlicher Datei-ID indiziertes Objekt; das URL-Feld heißt für beide Dateitypen attachment_url.
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
data object erforderlich Schema für zusätzliche Felder
id Typ nicht eingeschränkt erforderlich anyOf · Mindestens eine Variante muss passen
Variante 1 string Öffentliche v2-ID aus dem ausgewählten Konto; keine interne Datenbank-ID.
- pattern
"^attachment_[a-f0-9]{12}_-?[0-9]+$"
Variante 2 string Öffentliche v2-ID aus dem ausgewählten Konto; keine interne Datenbank-ID.
- pattern
"^pdftemplate_[a-f0-9]{12}_-?[0-9]+$"
emailtemplate string erforderlich Öffentliche v2-ID aus dem ausgewählten Konto; keine interne Datenbank-ID.
- pattern
"^et_[a-f0-9]{12}_-?[0-9]+$"
file_name string erforderlich file_size integer erforderlich last_change string erforderlich - format
"date-time"
attachment_url string erforderlich - format
"uri"
Zusätzliche, hier nicht aufgeführte Felder sind erlaubt.
error Typ nicht eingeschränkt erforderlich Fester Wert: false
type string success Typ nicht eingeschränkt Fester Wert: true
Zusätzliche, hier nicht aufgeführte Felder sind erlaubt.
Vollständiges Schema als JSON
{
"type": "object",
"required": [
"data",
"error"
],
"properties": {
"data": {
"type": "object",
"additionalProperties": {
"type": "object",
"properties": {
"id": {
"anyOf": [
{
"type": "string",
"pattern": "^attachment_[a-f0-9]{12}_-?[0-9]+$",
"description": "Öffentliche v2-ID aus dem ausgewählten Konto; keine interne Datenbank-ID."
},
{
"type": "string",
"pattern": "^pdftemplate_[a-f0-9]{12}_-?[0-9]+$",
"description": "Öffentliche v2-ID aus dem ausgewählten Konto; keine interne Datenbank-ID."
}
]
},
"emailtemplate": {
"type": "string",
"pattern": "^et_[a-f0-9]{12}_-?[0-9]+$",
"description": "Öffentliche v2-ID aus dem ausgewählten Konto; keine interne Datenbank-ID."
},
"file_name": {
"type": "string"
},
"file_size": {
"type": "integer"
},
"last_change": {
"type": "string",
"format": "date-time"
},
"attachment_url": {
"type": "string",
"format": "uri"
}
},
"additionalProperties": true,
"required": [
"id",
"emailtemplate",
"file_name",
"file_size",
"last_change",
"attachment_url"
]
}
},
"error": {
"const": false
},
"type": {
"type": "string"
},
"success": {
"const": true
}
},
"additionalProperties": true
}Beispiel
{
"data": {
"attachment_012345abcdef_123456": {
"id": "attachment_012345abcdef_123456",
"emailtemplate": "et_012345abcdef_123456",
"file_name": "Information.pdf",
"file_size": 1200,
"last_change": "2026-10-22T10:00:00+00:00",
"attachment_url": "https://example.org/signed-download"
}
},
"error": false,
"type": "admin",
"success": 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/Emailtemplate.php:330getEmailtemplate()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
falsex-edoobox-user-handoff
{
"sensitivePaths": [
"/data"
],
"oneTime": true
}x-edoobox-sensitive-response-paths
[
"/data/*/attachment_url"
]x-edoobox-user-handoff-source
{
"file": "application/models/v2/Emailtemplatefunc.php",
"method": "_showPDFAttachment",
"line": 554,
"lineEnd": 642,
"reason": "The typed child lookup is constrained to an account-owned parent, rejects pending objects, and returns a signed storage URL alongside child/parent v2 IDs and file metadata. Deliver the complete data map only through the protected one-time authenticated human handoff. Signed URL, signature and legacy object path must not enter model results, previews, logs or normal result caches. Upstream URL lifetime is unchanged.",
"sha256": "c25b711ef69b6cf6bb0bd4946a4f2ff0c2467fc1a8cc7a2df48187ddcb9bd60f"
}x-edoobox-runtimeMutationGuard
truex-edoobox-get-effect
"read"x-edoobox-documentationReview
{
"file": "docs/openapi/operation-contracts/09-messages-ai.json",
"notes": []
}x-edoobox-source
{
"file": "application/models/v2/Emailtemplate.php",
"method": "getEmailtemplate",
"line": 330,
"branch": {
"file": "application/models/v2/Emailtemplate.php",
"line": 345
}
}x-edoobox-documentationStatus
"reviewed"x-edoobox-readOnly
truex-edoobox-safeForAutomation
falsex-edoobox-permission
{
"resource": "emailtemplate",
"short": "emtp",
"checkedByDispatcher": true,
"levels": [
1,
3,
4
],
"description": "Resource permission mapping from APIPermissions(), Authfunc::_getCheckJWT. Additional model/admin/plugin checks may apply; resources absent from api_permission do not acquire a fictitious scope."
}Vollständige Operation als JSON
{
"operationId": "get_v2_emailtemplate_id_pdf_template_url",
"summary": "Signierte Lese-URL einer Vorlagendatei abrufen",
"description": "Liefert Metadaten und eine signierte Lese-URL für einen bereits verifizierten Anhang oder PDF-Hintergrund des Kontos. Die ID bezeichnet attachment_ oder pdftemplate_. Die Aktion lädt keine Datei hoch und ändert keine Vorlagen. Die öffentliche Datei-ID im Pfad wird als ID-Filter verwendet.",
"tags": [
"emailtemplate"
],
"security": [
{
"bearerAuth": [],
"accountContext": []
},
{
"sessionCookie": [],
"accountContext": []
}
],
"parameters": [
{
"name": "filter",
"in": "query",
"required": false,
"description": "JSON-encoded filter value consumed by RequestAPIData / API_DATA; specific actions may ignore it.",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "object",
"properties": {
"property": {
"type": "string"
},
"expression": {
"type": "string"
},
"value": {}
},
"additionalProperties": true
},
"examples": [
[
{
"property": "id",
"expression": "=",
"value": "emailtemplate_012345abcdef_123456"
}
]
]
},
"example": [
{
"property": "id",
"expression": "=",
"value": "emailtemplate_012345abcdef_123456"
}
]
}
}
},
{
"name": "language",
"in": "header",
"required": false,
"description": "Account language code, where the resource supports setLanguage().",
"schema": {
"type": "string",
"examples": [
"de"
]
}
},
{
"name": "id",
"in": "path",
"required": true,
"description": "Öffentliche Datei-ID.",
"schema": {
"anyOf": [
{
"type": "string",
"pattern": "^attachment_[a-f0-9]{12}_-?[0-9]+$",
"description": "Öffentliche v2-ID aus dem ausgewählten Konto; keine interne Datenbank-ID."
},
{
"type": "string",
"pattern": "^pdftemplate_[a-f0-9]{12}_-?[0-9]+$",
"description": "Öffentliche v2-ID aus dem ausgewählten Konto; keine interne Datenbank-ID."
}
]
}
},
{
"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": "Nach öffentlicher Datei-ID indiziertes Objekt; das URL-Feld heißt für beide Dateitypen attachment_url.",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"data",
"error"
],
"properties": {
"data": {
"type": "object",
"additionalProperties": {
"type": "object",
"properties": {
"id": {
"anyOf": [
{
"type": "string",
"pattern": "^attachment_[a-f0-9]{12}_-?[0-9]+$",
"description": "Öffentliche v2-ID aus dem ausgewählten Konto; keine interne Datenbank-ID."
},
{
"type": "string",
"pattern": "^pdftemplate_[a-f0-9]{12}_-?[0-9]+$",
"description": "Öffentliche v2-ID aus dem ausgewählten Konto; keine interne Datenbank-ID."
}
]
},
"emailtemplate": {
"type": "string",
"pattern": "^et_[a-f0-9]{12}_-?[0-9]+$",
"description": "Öffentliche v2-ID aus dem ausgewählten Konto; keine interne Datenbank-ID."
},
"file_name": {
"type": "string"
},
"file_size": {
"type": "integer"
},
"last_change": {
"type": "string",
"format": "date-time"
},
"attachment_url": {
"type": "string",
"format": "uri"
}
},
"additionalProperties": true,
"required": [
"id",
"emailtemplate",
"file_name",
"file_size",
"last_change",
"attachment_url"
]
}
},
"error": {
"const": false
},
"type": {
"type": "string"
},
"success": {
"const": true
}
},
"additionalProperties": true
},
"example": {
"data": {
"attachment_012345abcdef_123456": {
"id": "attachment_012345abcdef_123456",
"emailtemplate": "et_012345abcdef_123456",
"file_name": "Information.pdf",
"file_size": 1200,
"last_change": "2026-10-22T10:00:00+00:00",
"attachment_url": "https://example.org/signed-download"
}
},
"error": false,
"type": "admin",
"success": true
}
}
},
"headers": {
"X-Edoobox-Revision": {
"schema": {
"type": "string",
"pattern": "^[a-f0-9]{32}$"
},
"description": "Rotated account revision supplied for the next action in one reviewed sequence."
}
}
},
"400": {
"description": "Invalid request.",
"content": {
"application/json": {
"example": {
"success": false,
"error": "ED40006"
}
}
}
},
"401": {
"description": "Missing/expired token, missing account context, account paused or model-specific authorization failure.",
"content": {
"application/json": {
"example": {
"success": false,
"error": "ED40103"
}
}
}
},
"402": {
"description": "Missing/invalid action data or subscription/operation restriction.",
"content": {
"application/json": {
"example": {
"success": false,
"error": "ED80100"
}
}
}
},
"403": {
"description": "Permission denied. Browser CORS rejection may have an empty body.",
"content": {
"application/json": {
"example": {
"success": false,
"error": "ED40340"
}
}
}
},
"404": {
"description": "Unknown resource/action or unsupported method.",
"content": {
"application/json": {
"example": {
"success": false,
"error": "ED80019"
}
}
}
},
"409": {
"description": "The account changed after the reviewed read. No domain operation is dispatched; obtain fresh state and review again.",
"content": {
"application/json": {
"schema": {
"type": "object",
"additionalProperties": true
},
"example": {
"error": "ED40901",
"error_code": "mutation_revision_conflict"
}
}
}
},
"422": {
"description": "Validation failed.",
"content": {
"application/json": {
"example": {
"success": false,
"error": "ED80020"
}
}
}
},
"429": {
"description": "Request/login rate limit exceeded. Honor Retry-After when supplied; legacy rate-limit paths may omit it. Retry only proven reads within a bounded deadline; a mutation is never automatically replayed after an ambiguous response.",
"content": {
"application/json": {
"example": {
"success": false,
"error": "ED42902"
}
}
},
"headers": {
"Retry-After": {
"description": "Optional server delay in whole seconds or an HTTP date. Absence is not permission for an immediate retry.",
"schema": {
"type": "string",
"examples": [
"30"
]
}
}
}
},
"502": {
"description": "Server-side operation failed.",
"content": {
"application/json": {
"example": {
"success": false,
"error": "ED50201"
}
}
}
},
"503": {
"description": "The account mutation lock or revision store is unavailable. No unprotected fallback is executed.",
"headers": {
"Retry-After": {
"schema": {
"type": "integer",
"const": 1
}
}
},
"content": {
"application/json": {
"schema": {
"type": "object",
"additionalProperties": true
},
"example": {
"error": "ED50301",
"error_code": "mutation_revision_busy"
}
}
}
}
},
"x-edoobox-mutates-state": false,
"x-edoobox-user-handoff": {
"sensitivePaths": [
"/data"
],
"oneTime": true
},
"x-edoobox-sensitive-response-paths": [
"/data/*/attachment_url"
],
"x-edoobox-user-handoff-source": {
"file": "application/models/v2/Emailtemplatefunc.php",
"method": "_showPDFAttachment",
"line": 554,
"lineEnd": 642,
"reason": "The typed child lookup is constrained to an account-owned parent, rejects pending objects, and returns a signed storage URL alongside child/parent v2 IDs and file metadata. Deliver the complete data map only through the protected one-time authenticated human handoff. Signed URL, signature and legacy object path must not enter model results, previews, logs or normal result caches. Upstream URL lifetime is unchanged.",
"sha256": "c25b711ef69b6cf6bb0bd4946a4f2ff0c2467fc1a8cc7a2df48187ddcb9bd60f"
},
"x-edoobox-runtimeMutationGuard": true,
"x-edoobox-get-effect": "read",
"x-edoobox-documentationReview": {
"file": "docs/openapi/operation-contracts/09-messages-ai.json",
"notes": []
},
"x-edoobox-source": {
"file": "application/models/v2/Emailtemplate.php",
"method": "getEmailtemplate",
"line": 330,
"branch": {
"file": "application/models/v2/Emailtemplate.php",
"line": 345
}
},
"x-edoobox-documentationStatus": "reviewed",
"x-edoobox-readOnly": true,
"x-edoobox-safeForAutomation": false,
"x-edoobox-permission": {
"resource": "emailtemplate",
"short": "emtp",
"checkedByDispatcher": true,
"levels": [
1,
3,
4
],
"description": "Resource permission mapping from APIPermissions(), Authfunc::_getCheckJWT. Additional model/admin/plugin checks may apply; resources absent from api_permission do not acquire a fictitious scope."
}
}