Zum Inhalt springen
API-Referenz
API-Referenz

Batch-Objekt

Ein kontoweiter Moderations-Batch, dessen Ausführungslebenszyklus durch die kompatible Batch-API gemeldet wird.

Markdown anzeigen

Ein kontoweiter Moderations-Batch, dessen Ausführungslebenszyklus durch die kompatible Batch-API gemeldet wird.

01

Objektfelder

JSON-Body

Stabile Felder, die vom wiederverwendbaren Objekt der Ressource geteilt werden.

Stapel23 Felder
cancelled_atinteger | null
Optional

Unix-Zeitstempel, wann der Batch abgebrochen wurde.

cancelling_atinteger | null
Optional

Unix-Zeitstempel, wann der Abbruch begann.

completed_atinteger | null
Optional

Unix-Zeitstempel, wann der Batch abgeschlossen wurde.

completion_windowstring
Erforderlich

Abschlussfenster für den Batch.

created_atinteger
Erforderlich

Unix-Zeitstempel, wann der Batch erstellt wurde.

endpointstring
Erforderlich

Moderationsendpunkt, der vom Batch verarbeitet wird.

error_file_idstring | null
Optional

RunAPI-Fehler-Datei-ID

errorsobject | null
Optional

Validierungs- oder Ausführungsfehler im Batch

expired_atinteger | null
Optional

Unix-Zeitstempel, wann der Batch abgelaufen ist.

expires_atinteger | null
Optional

Unix-Zeitstempel, wann der Batch abläuft.

failed_atinteger | null
Optional

Unix-Zeitstempel, wann der Batch fehlgeschlagen ist.

finalizing_atinteger | null
Optional

Unix-Zeitstempel, wann der Batch in die Abschlussphase eingetreten ist.

idstring
Erforderlich

RunAPI Batch-ID.

in_progress_atinteger | null
Optional

Unix-Zeitstempel, wann die Batch-Verarbeitung begann.

input_file_idstring
Erforderlich

RunAPI-Eingabe-Datei-ID.

metadataobject
Erforderlich

Mit dem Batch zurückgegebene Aufrufer-Metadaten.

objectstring
Erforderlich

Objekttyp.

output_file_idstring | null
Optional

RunAPI-Ausgabe-Datei-ID

request_countsobject
Erforderlich
request_counts.completedinteger
Erforderlich
request_counts.failedinteger
Erforderlich
request_counts.totalinteger
Erforderlich
statusstring
Erforderlich

Lebenszyklusstatus des Batches.

Zulässige Werte: validating, failed, in_progress, finalizing, completed, expired, cancelling, cancelled