Naar inhoud springen
API-referentie
API-referentie

Batch-object

Een op account-niveau ingestelde moderatiebatch waarvan de uitvoeringslevenscyclus wordt gerapporteerd door de compatibele Batch API.

Een op account-niveau ingestelde moderatiebatch waarvan de uitvoeringslevenscyclus wordt gerapporteerd door de compatibele Batch API.

01

Objectvelden

JSON-body

Stabiele velden die worden gedeeld door het herbruikbare object van de resource.

Batches23 velden
cancelled_atinteger | null
Optioneel

Unix-tijdstempel waarop de batch geannuleerd was.

cancelling_atinteger | null
Optioneel

Unix-tijdstempel waarop annulering begon.

completed_atinteger | null
Optioneel

Unix-tijdstempel waarop de batch voltooid was.

completion_windowstring
Verplicht

Voltooiingsvenster voor de Batch.

created_atinteger
Verplicht

Unix-tijdstempel waarop de batch is aangemaakt.

endpointstring
Verplicht

Moderatie-eindpunt verwerkt door de batch.

error_file_idstring | null
Optioneel

RunAPI fout File ID

errorsobject | null
Optioneel

Validatie- of uitvoeringsfouten van de Batch

expired_atinteger | null
Optioneel

Unix-tijdstempel waarop de batch verlopen is.

expires_atinteger | null
Optioneel

Unix-tijdstempel waarop de batch verloopt.

failed_atinteger | null
Optioneel

Unix-tijdstempel waarop de batch mislukt is.

finalizing_atinteger | null
Optioneel

Unix-tijdstempel waarop de batch de afrondingsfase inging.

idstring
Verplicht

RunAPI Batch ID.

in_progress_atinteger | null
Optioneel

Unix-tijdstempel waarop batchverwerking begon.

input_file_idstring
Verplicht

RunAPI invoer File ID.

metadataobject
Verplicht

Aanroepermetagegevens teruggegeven bij de Batch.

objectstring
Verplicht

Objecttype.

output_file_idstring | null
Optioneel

RunAPI uitvoer File ID

request_countsobject
Verplicht
request_counts.completedinteger
Verplicht
request_counts.failedinteger
Verplicht
request_counts.totalinteger
Verplicht
statusstring
Verplicht

Levenscyclusstatus van de Batch.

Toegestane waarden: validating, failed, in_progress, finalizing, completed, expired, cancelling, cancelled