APIReferenz

Exports API

Generierte OpenAPI-Referenz für die Exports-API-Oberfläche.

Überblick

Exports-Endpoints gehören zur öffentlichen Everyn-API. Self-starting CSV exports. Clients create, poll/list/read, and download ready exports through the API; there is no public execute action.

Endpunkte

Die generierte OpenAPI-Komponente unten enthält Request-Parameter, Request Bodies, Response Bodies, Statuscodes und Schemas für dieses Tag.

Endpoint-Zusammenfassung für den schnellen Überblick vor der generierten Referenz:

Fehler nutzen die PublicErrorEnvelope-Form mit einem X-Request-Id-Header. Die meisten Endpoints unten liefern 400, 401, 403, 404, 409, 422, 429; die wenigen Abweichungen listen ihre eigenen Statuscodes in der Tabelle, die sonst nur Erfolgs-Responses zeigt. Siehe API-Fehler für Envelope und Recovery-Muster.

MethodePfadZusammenfassungRequest BodyErfolgs-Response
GET/v1/exportsList ExportsKeine.200 application/json: Page_ExportResponse_
GET/v1/exports/{export_id}Get ExportKeine.200 application/json: ExportResponse
GET/v1/exports/{export_id}/downloadDownload ExportKeine.200 text/csv: string
Fehler: 400, 401, 403, 404, 409, 410, 422, 429.
GET/v1/runs/{run_id}/exportsList Run ExportsKeine.200 application/json: Page_ExportResponse_
POST/v1/runs/{run_id}/exportsCreate Exportapplication/json: ExportCreateRequestBody201 application/json: ExportResponse

API-Referenz wird geladen...