Teilnehmerdatei anlegen

{
  "operationId": "post_v2_file",
  "summary": "Teilnehmerdatei anlegen",
  "description": "Reserviert eine Teilnehmerdatei und liefert eine signierte Upload-URL. Das über user und datafield ausgewählte aktivierte Dateifeld darf noch keine aktive Datei enthalten; das Teilnehmerfeld wird bereits beim Reservieren aktualisiert. Datei-Bytes werden anschließend separat an upload_url übertragen. file_size ist eine Byte-Angabe im Request; die Metadaten speichern gerundete MiB, deren GET-Ausgabe zusätzlich zu int normalisiert wird. Die Erweiterung wird aus file_name abgeleitet; Datei-URLs sind vertraulich.",
  "tags": [
    "file"
  ],
  "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, öffentliche id und bei Uploads signierte upload_url; öffentliche Dateien liefern zusätzlich cdn_url.",
      "content": {
        "application/json": {
          "example": {
            "success": true,
            "error": false,
            "data": {
              "insert": true,
              "id": "file_012345abcdef_123456",
              "upload_url": "https://storage.example.invalid/synthetic-upload"
            }
          },
          "schema": {
            "type": "object",
            "properties": {
              "success": {
                "type": "boolean"
              },
              "error": {
                "type": [
                  "boolean",
                  "string"
                ]
              },
              "error_code": {
                "type": "string"
              },
              "data": {
                "type": "object",
                "properties": {
                  "id": {
                    "type": "string",
                    "pattern": "^file_[a-f0-9]{12}_-?[0-9]+$",
                    "description": "Öffentliche v2-ID aus diesem Konto; keine Datenbank-ID. Beispiel ist synthetisch.",
                    "examples": [
                      "file_012345abcdef_123456"
                    ]
                  },
                  "insert": {
                    "type": "boolean"
                  },
                  "upload_url": {
                    "type": "string",
                    "format": "uri",
                    "description": "Signierte Upload-URL; vertraulich und zeitlich begrenzt."
                  }
                },
                "additionalProperties": true,
                "required": [
                  "id",
                  "insert",
                  "upload_url"
                ]
              },
              "type": {
                "type": "string"
              }
            },
            "additionalProperties": true
          }
        }
      },
      "headers": {
        "X-Edoobox-Revision": {
          "schema": {
            "type": "string",
            "pattern": "^[a-f0-9]{32}$"
          },
          "description": "Rotated account revision supplied for the next action in one reviewed sequence."
        }
      }
    },
    "400": {
      "description": "Invalid request.",
      "content": {
        "application/json": {
          "example": {
            "success": false,
            "error": "ED40006"
          }
        }
      }
    },
    "401": {
      "description": "Missing/expired token, missing account context, account paused or model-specific authorization failure.",
      "content": {
        "application/json": {
          "example": {
            "success": false,
            "error": "ED40103"
          }
        }
      }
    },
    "402": {
      "description": "Missing/invalid action data or subscription/operation restriction.",
      "content": {
        "application/json": {
          "example": {
            "success": false,
            "error": "ED80100"
          }
        }
      }
    },
    "403": {
      "description": "Permission denied. Browser CORS rejection may have an empty body.",
      "content": {
        "application/json": {
          "example": {
            "success": false,
            "error": "ED40340"
          }
        }
      }
    },
    "404": {
      "description": "Unknown resource/action or unsupported method.",
      "content": {
        "application/json": {
          "example": {
            "success": false,
            "error": "ED80019"
          }
        }
      }
    },
    "409": {
      "description": "The account changed after the reviewed read. No domain operation is dispatched; obtain fresh state and review again.",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": true
          },
          "example": {
            "error": "ED40901",
            "error_code": "mutation_revision_conflict"
          }
        }
      }
    },
    "422": {
      "description": "Validation failed.",
      "content": {
        "application/json": {
          "example": {
            "success": false,
            "error": "ED80020"
          }
        }
      }
    },
    "429": {
      "description": "Request/login rate limit exceeded. Honor Retry-After when supplied; legacy rate-limit paths may omit it. Retry only proven reads within a bounded deadline; a mutation is never automatically replayed after an ambiguous response.",
      "content": {
        "application/json": {
          "example": {
            "success": false,
            "error": "ED42902"
          }
        }
      },
      "headers": {
        "Retry-After": {
          "description": "Optional server delay in whole seconds or an HTTP date. Absence is not permission for an immediate retry.",
          "schema": {
            "type": "string",
            "examples": [
              "30"
            ]
          }
        }
      }
    },
    "502": {
      "description": "Server-side operation failed.",
      "content": {
        "application/json": {
          "example": {
            "success": false,
            "error": "ED50201"
          }
        }
      }
    },
    "503": {
      "description": "The account mutation lock or revision store is unavailable. No unprotected fallback is executed.",
      "headers": {
        "Retry-After": {
          "schema": {
            "type": "integer",
            "const": 1
          }
        }
      },
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": true
          },
          "example": {
            "error": "ED50301",
            "error_code": "mutation_revision_busy"
          }
        }
      }
    }
  },
  "x-edoobox-mutates-state": true,
  "requestBody": {
    "required": true,
    "content": {
      "application/json": {
        "schema": {
          "type": "object",
          "required": [
            "data"
          ],
          "properties": {
            "data": {
              "type": "object",
              "required": [
                "file_name",
                "file_type",
                "file_size",
                "user",
                "datafield"
              ],
              "properties": {
                "file_name": {
                  "type": "string",
                  "description": "The extension is lowercased from normalized file_name; supplied file_extension is ignored. The actual derived extension must have at most5 characters and contain no slash/backslash, C0/DEL or percent-encoded byte sequence. Private signed-storage names retain otherwise-safe ?, # and non-encoded percent punctuation."
                },
                "file_type": {
                  "type": "string",
                  "maxLength": 100,
                  "description": "Native getter rejects raw UTF-8 length over100 and normalized SQL-escaped storage length over100. Quote/backslash-rich input can reach the encoded limit earlier than the raw limit."
                },
                "file_size": {
                  "x-edoobox-canonicalType": "integer",
                  "description": "File byte count is PHP-int normalized; declared positive size is required by the upload workflow. The storage transfer independently verifies byte count.",
                  "examples": [
                    128
                  ]
                },
                "user": {
                  "type": "string",
                  "pattern": "^[a-z0-9]+_[a-f0-9]{12}_-?[0-9]+$",
                  "examples": [
                    "user_012345abcdef_123456"
                  ],
                  "description": "Existing tenant-bound public user v2 ID; never a database key."
                },
                "datafield": {
                  "type": "string",
                  "description": "Existing enabled custom datafield configured with type=file in this account; e.g. data_1."
                },
                "file_extension": {
                  "description": "Ignored by native create; the extension is derived from normalized file_name.",
                  "x-edoobox-ignored-input": true
                }
              },
              "additionalProperties": true,
              "description": "Source-specific single-record request; upstream account and validation checks apply."
            }
          },
          "additionalProperties": true
        },
        "examples": {
          "request": {
            "value": {
              "data": {
                "file_name": "example.pdf",
                "file_type": "application/pdf",
                "file_size": 128,
                "user": "user_012345abcdef_123456",
                "datafield": "data_1"
              }
            }
          }
        }
      }
    }
  },
  "x-edoobox-upload-ticket": {
    "provider": "s3",
    "bucketEnv": "AWS_S3_BUCKET",
    "regionEnv": "AWS_S3_REGION",
    "urlPointer": "/data/upload_url",
    "pathPrefixTemplate": "/ED{fid}F/",
    "method": "PUT",
    "expiresInSeconds": 1800,
    "source": {
      "file": "application/models/v2/Filefunc.php",
      "line": 7,
      "sha256": "b0a20df1ad9c325900275984aea76e884aac74f86aa3a08be34da1fed06e87b1",
      "method": "_postFile"
    },
    "workflow": {
      "metadataCreatedBeforeTransfer": true,
      "requiresApiFinalization": false,
      "scope": "object",
      "readback": {
        "operationId": "get_v2_file_id",
        "argumentBindings": [
          {
            "target": "/path/id",
            "source": "/data/id"
          }
        ],
        "proves": "metadata-only"
      },
      "abort": {
        "operationId": "delete_v2_file_id",
        "argumentBindings": [
          {
            "target": "/path/id",
            "source": "/data/id"
          }
        ],
        "storageCleanup": "native-delete-attempt"
      },
      "notes": [
        "The metadata row is created before the storage PUT. No API completion or upload-status operation exists for this resource.",
        "Metadata readback does not prove storage object existence or byte integrity. A ticket discard does not delete native metadata.",
        "Abort is a separate mutation requiring normal preview, approval and current authorization. Never automatically retry a PUT after an ambiguous outcome.",
        "Native deletion does not revoke a previously issued presigned URL. Do not race an in-flight transfer with abort; a late PUT can recreate an orphaned object."
      ]
    }
  },
  "x-edoobox-capability-source": {
    "file": "../edoobox-vue-2.0/src/store/file/moduleFileActions.js",
    "line": 75,
    "reason": "Participant datafield upload registers a file, then uploads bytes to the server-returned presigned URL."
  },
  "x-edoobox-upload-input-review": {
    "derivedExtensionLimit": 5,
    "providedExtension": "ignored",
    "nativeValidation": "The extension is lowercased from normalized file_name; supplied file_extension is ignored. The actual derived extension must have at most5 characters and contain no slash/backslash, C0/DEL or percent-encoded byte sequence. Private signed-storage names retain otherwise-safe ?, # and non-encoded percent punctuation.",
    "source": {
      "file": "application/models/v2/Filefunc.php",
      "line": 36,
      "sha256": "b0a20df1ad9c325900275984aea76e884aac74f86aa3a08be34da1fed06e87b1",
      "lineEnd": 49
    },
    "relatedSource": {
      "file": "application/models/v2/File.php",
      "line": 94,
      "sha256": "3e44cb5fcf8fb7f9a57fc5fd11c53501ee655885dd432798fc3f88867a55a81f"
    }
  },
  "x-edoobox-runtimeMutationGuard": true,
  "x-edoobox-documentationReview": {
    "file": "docs/openapi/operation-contracts/07-layout-files.json",
    "notes": []
  },
  "x-edoobox-source": {
    "file": "application/models/v2/File.php",
    "method": "postFile",
    "line": 156
  },
  "x-edoobox-documentationStatus": "reviewed",
  "x-edoobox-readOnly": false,
  "x-edoobox-safeForAutomation": false,
  "x-edoobox-permission": {
    "resource": "file",
    "short": "file",
    "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."
  }
}