Zum Inhalt
edoobox Docs
Kostenlos testen 7 Tage unverbindlich testen
Menü
Kostenlos testen 7 Tage unverbindlich testen
OpenAPI herunterladen
supportAPI-Referenz
POST/v2/support/error-feedback-reports/upload

Screenshot eines vorbereiteten Berichts hochladen

Speichert visualScreenshot oder annotatedScreenshot eines eigenen vorbereiteten Berichts als Alternative zum direkten Objektspeicher-Upload. reportId (oder feedbackKey), artifactKey und für noch nicht gespeicherte Anhänge dataUrl sind erforderlich. MIME, positive Größe bis 8 MiB sowie erwartete Größe/Hash müssen passen. Bereits gespeicherte Anhänge werden unverändert bestätigt; Replay ist hier nicht unterstützt. Die placeholder-Variante nutzt dieselbe Modellimplementierung. error=false bestätigt nicht automatisch erfolgreiche Anhänge; deren status muss ausgewertet werden. Berichte mit route.name=pageRegister oder /pages/register werden vom Controller deaktiviert; dann antwortet data.disabled=true mit reason=signup_error_feedback_disabled.

Operation-ID post_v2_support_error_feedback_reports_upload

01

Vertrag & Verhalten

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

Authentifizierung

Eine der folgenden Alternativen muss erfüllt sein (ODER). Innerhalb jeder Alternative werden alle angegebenen Schemas gemeinsam benötigt (UND).

Alternative 1

bearerAuthhttp · bearer

Existing edoobox v2 access token. Never substitute API key/secret headers.

Format: JWT

Security-Schema als JSON
{
  "type": "http",
  "scheme": "bearer",
  "bearerFormat": "JWT",
  "description": "Existing edoobox v2 access token. Never substitute API key/secret headers."
}
accountContextapiKey

Selected login/account context from the JWT, not a database primary key. Required even for a JWT with one account.

header: edid

Security-Schema als JSON
{
  "type": "apiKey",
  "in": "header",
  "name": "edid",
  "description": "Selected login/account context from the JWT, not a database primary key. Required even for a JWT with one account."
}

Alternative 2

sessionCookieapiKey

Existing browser login session, with the same permission checks as Bearer authentication.

cookie: _edlogin

Security-Schema als JSON
{
  "type": "apiKey",
  "in": "cookie",
  "name": "_edlogin",
  "description": "Existing browser login session, with the same permission checks as Bearer authentication."
}
accountContextapiKey

Selected login/account context from the JWT, not a database primary key. Required even for a JWT with one account.

header: edid

Security-Schema als JSON
{
  "type": "apiKey",
  "in": "header",
  "name": "edid",
  "description": "Selected login/account context from the JWT, not a database primary key. Required even for a JWT with one account."
}

Berechtigungen

Resource permission mapping from APIPermissions(), Authfunc::_getCheckJWT. Additional model/admin/plugin checks may apply; resources absent from api_permission do not acquire a fictitious scope.

03

Parameter

Header

languageoptional

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

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

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

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

Request Body

erforderlich

application/json

object
data object erforderlich
reportId string

Berichtsschlüssel aus prepare/create.

feedbackKey string

Alias für reportId.

artifactKey string erforderlich
dataUrl string

Base64-dataUrl des vorbereiteten Bildes.

anyOf · Mindestens eine Variante muss passen
Variante 1 Typ nicht eingeschränkt

Zusätzlich erforderlich, ohne eigenes Feldschema: reportId

Variante 2 Typ nicht eingeschränkt

Zusätzlich erforderlich, ohne eigenes Feldschema: feedbackKey

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

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

Vollständiges Schema als JSON
{
  "type": "object",
  "properties": {
    "data": {
      "type": "object",
      "properties": {
        "reportId": {
          "type": "string",
          "description": "Berichtsschlüssel aus prepare/create."
        },
        "feedbackKey": {
          "type": "string",
          "description": "Alias für reportId."
        },
        "artifactKey": {
          "type": "string"
        },
        "dataUrl": {
          "type": "string",
          "description": "Base64-dataUrl des vorbereiteten Bildes."
        }
      },
      "additionalProperties": true,
      "anyOf": [
        {
          "required": [
            "reportId"
          ]
        },
        {
          "required": [
            "feedbackKey"
          ]
        }
      ],
      "required": [
        "artifactKey"
      ]
    }
  },
  "additionalProperties": true,
  "required": [
    "data"
  ]
}
Screenshot eines vorbereiteten Berichts hochladen
{
  "data": {
    "reportId": "efb_syntheticexample",
    "artifactKey": "efa_syntheticexample",
    "dataUrl": "data:image/png;base64,iVBORw0KGgo="
  }
}
05

Antworten

11

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

200application/json

Berichts-/Anhangstatus stehen auf oberster Ebene, nicht unter data. Tabellen-/Speicherfehler können ebenfalls HTTP 200 verwenden. artifacts.status muss für jeden angeforderten Anhang geprüft werden.

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

Typ nicht eingeschränkt
anyOf · Mindestens eine Variante muss passen
Variante 1 object
success Typ nicht eingeschränkt erforderlich

Fester Wert: true

error Typ nicht eingeschränkt erforderlich

Fester Wert: false

key string
status string
type string
Erlaubte Werte
"visualScreenshot""annotatedScreenshot"

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

Variante 2 object
success Typ nicht eingeschränkt

Fester Wert: false

error string erforderlich
error_code string

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

Vollständiges Schema als JSON
{
  "anyOf": [
    {
      "type": "object",
      "properties": {
        "success": {
          "const": true
        },
        "error": {
          "const": false
        },
        "key": {
          "type": "string"
        },
        "status": {
          "type": "string"
        },
        "type": {
          "type": "string",
          "enum": [
            "visualScreenshot",
            "annotatedScreenshot"
          ]
        }
      },
      "additionalProperties": true,
      "required": [
        "success",
        "error"
      ]
    },
    {
      "type": "object",
      "properties": {
        "success": {
          "const": false
        },
        "error": {
          "type": "string"
        },
        "error_code": {
          "type": "string"
        }
      },
      "additionalProperties": true,
      "required": [
        "error"
      ]
    }
  ]
}
Beispiel
{
  "success": true,
  "error": false,
  "key": "efa_syntheticexample",
  "status": "stored",
  "type": "visualScreenshot"
}
400application/json

Invalid request.

application/json

Typ nicht eingeschränkt

Kein Schema angegeben. Daraus lässt sich kein vollständiger Feldvertrag ableiten.

Beispiel
{
  "success": false,
  "error": "ED40006"
}
401application/json

Missing/expired token, missing account context, account paused or model-specific authorization failure.

application/json

Typ nicht eingeschränkt

Kein Schema angegeben. Daraus lässt sich kein vollständiger Feldvertrag ableiten.

Beispiel
{
  "success": false,
  "error": "ED40103"
}
402application/json

Missing/invalid action data or subscription/operation restriction.

application/json

Typ nicht eingeschränkt

Kein Schema angegeben. Daraus lässt sich kein vollständiger Feldvertrag ableiten.

Beispiel
{
  "success": false,
  "error": "ED80100"
}
403application/json

Permission denied. Browser CORS rejection may have an empty body.

application/json

Typ nicht eingeschränkt

Kein Schema angegeben. Daraus lässt sich kein vollständiger Feldvertrag ableiten.

Beispiel
{
  "success": false,
  "error": "ED40340"
}
404application/json

Unknown resource/action or unsupported method.

application/json

Typ nicht eingeschränkt

Kein Schema angegeben. Daraus lässt sich kein vollständiger Feldvertrag ableiten.

Beispiel
{
  "success": false,
  "error": "ED80019"
}
409application/json

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

application/json

object

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

Vollständiges Schema als JSON
{
  "type": "object",
  "additionalProperties": true
}
Beispiel
{
  "error": "ED40901",
  "error_code": "mutation_revision_conflict"
}
422application/json

Validation failed.

application/json

Typ nicht eingeschränkt

Kein Schema angegeben. Daraus lässt sich kein vollständiger Feldvertrag ableiten.

Beispiel
{
  "success": false,
  "error": "ED80020"
}
429application/json

Request/login rate limit exceeded. Honor Retry-After when supplied; legacy rate-limit paths may omit it. Retry only proven reads within a bounded deadline; a mutation is never automatically replayed after an ambiguous response.

Response Header

Retry-After

Optional server delay in whole seconds or an HTTP date. Absence is not permission for an immediate retry.

string
Schema-Beispiel
"30"
Vollständiges Schema als JSON
{
  "type": "string",
  "examples": [
    "30"
  ]
}

application/json

Typ nicht eingeschränkt

Kein Schema angegeben. Daraus lässt sich kein vollständiger Feldvertrag ableiten.

Beispiel
{
  "success": false,
  "error": "ED42902"
}
502application/json

Server-side operation failed.

application/json

Typ nicht eingeschränkt

Kein Schema angegeben. Daraus lässt sich kein vollständiger Feldvertrag ableiten.

Beispiel
{
  "success": false,
  "error": "ED50201"
}
503application/json

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

Response Header

Retry-After

integer

Fester Wert: 1

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

application/json

object

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

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

Quelle & Metadaten

Quelle laut Spezifikationapplication/models/v2/Support.php:10postSupport()

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/10-other-resources.json",
  "notes": []
}
x-edoobox-source
{
  "file": "application/models/v2/Support.php",
  "method": "postSupport",
  "line": 10
}
x-edoobox-documentationStatus
"reviewed"
x-edoobox-readOnly
false
x-edoobox-safeForAutomation
false
x-edoobox-permission
{
  "resource": "support",
  "short": null,
  "checkedByDispatcher": false,
  "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_support_error_feedback_reports_upload",
  "summary": "Screenshot eines vorbereiteten Berichts hochladen",
  "description": "Speichert visualScreenshot oder annotatedScreenshot eines eigenen vorbereiteten Berichts als Alternative zum direkten Objektspeicher-Upload. reportId (oder feedbackKey), artifactKey und für noch nicht gespeicherte Anhänge dataUrl sind erforderlich. MIME, positive Größe bis 8 MiB sowie erwartete Größe/Hash müssen passen. Bereits gespeicherte Anhänge werden unverändert bestätigt; Replay ist hier nicht unterstützt. Die placeholder-Variante nutzt dieselbe Modellimplementierung. error=false bestätigt nicht automatisch erfolgreiche Anhänge; deren status muss ausgewertet werden. Berichte mit route.name=pageRegister oder /pages/register werden vom Controller deaktiviert; dann antwortet data.disabled=true mit reason=signup_error_feedback_disabled.",
  "tags": [
    "support"
  ],
  "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": "Berichts-/Anhangstatus stehen auf oberster Ebene, nicht unter data. Tabellen-/Speicherfehler können ebenfalls HTTP 200 verwenden. artifacts.status muss für jeden angeforderten Anhang geprüft werden.",
      "content": {
        "application/json": {
          "schema": {
            "anyOf": [
              {
                "type": "object",
                "properties": {
                  "success": {
                    "const": true
                  },
                  "error": {
                    "const": false
                  },
                  "key": {
                    "type": "string"
                  },
                  "status": {
                    "type": "string"
                  },
                  "type": {
                    "type": "string",
                    "enum": [
                      "visualScreenshot",
                      "annotatedScreenshot"
                    ]
                  }
                },
                "additionalProperties": true,
                "required": [
                  "success",
                  "error"
                ]
              },
              {
                "type": "object",
                "properties": {
                  "success": {
                    "const": false
                  },
                  "error": {
                    "type": "string"
                  },
                  "error_code": {
                    "type": "string"
                  }
                },
                "additionalProperties": true,
                "required": [
                  "error"
                ]
              }
            ]
          },
          "example": {
            "success": true,
            "error": false,
            "key": "efa_syntheticexample",
            "status": "stored",
            "type": "visualScreenshot"
          }
        }
      },
      "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": {
              "type": "object",
              "properties": {
                "reportId": {
                  "type": "string",
                  "description": "Berichtsschlüssel aus prepare/create."
                },
                "feedbackKey": {
                  "type": "string",
                  "description": "Alias für reportId."
                },
                "artifactKey": {
                  "type": "string"
                },
                "dataUrl": {
                  "type": "string",
                  "description": "Base64-dataUrl des vorbereiteten Bildes."
                }
              },
              "additionalProperties": true,
              "anyOf": [
                {
                  "required": [
                    "reportId"
                  ]
                },
                {
                  "required": [
                    "feedbackKey"
                  ]
                }
              ],
              "required": [
                "artifactKey"
              ]
            }
          },
          "additionalProperties": true,
          "required": [
            "data"
          ]
        },
        "examples": {
          "request": {
            "summary": "Screenshot eines vorbereiteten Berichts hochladen",
            "value": {
              "data": {
                "reportId": "efb_syntheticexample",
                "artifactKey": "efa_syntheticexample",
                "dataUrl": "data:image/png;base64,iVBORw0KGgo="
              }
            }
          }
        }
      }
    }
  },
  "x-edoobox-runtimeMutationGuard": true,
  "x-edoobox-documentationReview": {
    "file": "docs/openapi/operation-contracts/10-other-resources.json",
    "notes": []
  },
  "x-edoobox-source": {
    "file": "application/models/v2/Support.php",
    "method": "postSupport",
    "line": 10
  },
  "x-edoobox-documentationStatus": "reviewed",
  "x-edoobox-readOnly": false,
  "x-edoobox-safeForAutomation": false,
  "x-edoobox-permission": {
    "resource": "support",
    "short": null,
    "checkedByDispatcher": false,
    "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."
  }
}