> ## Documentation Index
> Fetch the complete documentation index at: https://docs.olostep.com/llms.txt
> Use this file to discover all available pages before exploring further.
# Batch aktualisieren
> Aktualisiert die Metadaten für einen bestimmten Batch. Nur Metadaten können nach der Batch-Erstellung aktualisiert werden.
**Merge-Semantik:** Metadatenaktualisierungen folgen dem Ansatz von Stripe — neue Schlüssel werden hinzugefügt, bestehende Schlüssel werden aktualisiert, und auf leeren String `""` gesetzte Schlüssel werden gelöscht.
## OpenAPI
````yaml de/openapi/batches.json PATCH /v1/batches/{batch_id}
openapi: 3.0.3
info:
title: Batches-API
version: 1.0.0
servers:
- url: https://api.olostep.com
security: []
paths:
/v1/batches/{batch_id}:
patch:
summary: Batch-Metadaten aktualisieren
description: >-
Aktualisiert die Metadaten für einen bestimmten Batch. Nur das
`metadata`-Feld kann aktualisiert werden. Folgt den Merge-Semantiken von
Stripe: Neue Schlüssel werden hinzugefügt, bestehende Schlüssel werden
aktualisiert, und Schlüssel, die auf einen leeren String gesetzt sind,
werden gelöscht.
parameters:
- name: batch_id
in: path
required: true
schema:
type: string
description: Die ID des Batches, der aktualisiert werden soll.
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
metadata:
$ref: '#/components/schemas/Metadata'
required:
- metadata
example:
metadata:
status: reviewed
reviewer: jane@example.com
responses:
'200':
description: Batch-Metadaten erfolgreich aktualisiert.
content:
application/json:
schema:
type: object
properties:
id:
type: string
description: Batch-ID
object:
type: string
description: Die Art des Objekts. "batch" für diesen Endpunkt.
status:
type: string
description: '`in_progress` oder `completed`'
created:
type: number
description: Erstellte Epoche
total_urls:
type: number
description: Anzahl der URLs im Batch
completed_urls:
type: number
description: Anzahl der abgeschlossenen URLs
metadata:
$ref: '#/components/schemas/Metadata'
example:
id: batch_abc123def456
object: batch
status: completed
created: 1704067200
total_urls: 10
completed_urls: 10
metadata:
batch_name: Q1 Product Sync
status: reviewed
reviewer: jane@example.com
'400':
description: >-
Ungültige Anfrage - fehlende oder ungültige Metadaten. Siehe [Bad
Request](/api-reference/errors/bad_request) für Details.
content:
application/problem+json:
schema:
$ref: '#/components/schemas/Error'
example:
id: error_abc123
object: error
code: invalid_metadata
type: https://docs.olostep.com/api-reference/errors/bad_request
status: 400
title: Ungültige Anfrage
detail: No metadata field provided. Only metadata can be updated.
created: 1704067200
metadata: {}
'401':
description: >-
Authentifizierungsdaten fehlen oder sind ungültig. Siehe
[Unauthorized](/api-reference/errors/unauthorized) für Details.
content:
application/problem+json:
schema:
$ref: '#/components/schemas/Error'
example:
id: error_abc123
object: error
code: invalid_api_key
type: https://docs.olostep.com/api-reference/errors/unauthorized
status: 401
title: Nicht autorisiert
detail: Your API key is invalid
created: 1704067200
metadata: {}
'404':
description: >-
Batch für die angegebene ID nicht gefunden. Siehe [Not
Found](/api-reference/errors/not_found) für Details.
content:
application/problem+json:
schema:
$ref: '#/components/schemas/Error'
example:
id: error_abc123
object: error
code: batch_not_found
type: https://docs.olostep.com/api-reference/errors/not_found
status: 404
title: Nicht gefunden
detail: Batch not found
created: 1704067200
metadata: {}
'500':
description: >-
Interner Serverfehler. Siehe [Internal
Error](/api-reference/errors/internal_error) für Details.
content:
application/problem+json:
schema:
$ref: '#/components/schemas/Error'
example:
id: error_abc123
object: error
code: internal_server_error
type: https://docs.olostep.com/api-reference/errors/internal_error
status: 500
title: Interner Serverfehler
detail: An unexpected error occurred
created: 1704067200
metadata: {}
security:
- Authorization: []
components:
schemas:
Metadata:
type: object
description: >-
Satz von Schlüssel-Wert-Paaren zur Speicherung zusätzlicher
Informationen über ein Objekt. Folgt dem Ansatz von Stripe mit
Validierungsregeln: maximal 50 Schlüssel, Schlüssel maximal 40 Zeichen
(keine eckigen Klammern), Wert maximal 500 Zeichen, alle Werte als
Strings gespeichert.
additionalProperties:
type: string
maxLength: 500
description: >-
Metadatenwert (maximal 500 Zeichen). Zahlen und Booleans werden
automatisch in Strings umgewandelt.
maxProperties: 50
example:
order_id: '12345'
customer_name: John Doe
priority: high
processed: 'true'
x-validation-rules:
max_keys: 50
key_max_length: 40
key_forbidden_chars:
- '['
- ']'
value_max_length: 500
value_types:
- string
- number (coerced)
- boolean (coerced)
Error:
type: object
description: RFC 7807 Problem Details Fehlerantwort
properties:
id:
type: string
description: Eindeutige Fehlerkennung
object:
type: string
enum:
- error
description: Immer 'error'
code:
type: string
description: Maschinenlesbarer Fehlercode
type:
type: string
format: uri
description: URI-Referenz, die den Problemtyp identifiziert
status:
type: integer
description: HTTP-Statuscode
title:
type: string
description: Kurze, menschenlesbare Zusammenfassung
detail:
type: string
description: Menschenlesbare Erklärung
created:
type: integer
description: Unix-Zeitstempel
metadata:
$ref: '#/components/schemas/Metadata'
errors:
type: array
description: Optionale Liste zusätzlicher Fehlerdetails
items: {}
required:
- id
- object
- code
- type
- status
- title
- detail
- created
securitySchemes:
Authorization:
type: http
scheme: bearer
description: >-
Bearer-Authentifizierungsheader in der Form Bearer , wobei
dein Authentifizierungstoken ist.
````