> ## 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-Elemente
> Ruft die Liste der für einen Batch verarbeiteten Elemente ab. Du kannst dann die `retrieve_id` verwenden, um den Inhalt mit dem Retrieve Endpoint zu erhalten.
**Metadaten:** Wenn du `metadata` an einzelne Elemente angehängt hast, als du den [Batch erstellt hast](/api-reference/batches/create), wird es mit jedem Element in der Antwort zurückgegeben.
## OpenAPI
````yaml de/openapi/batches.json GET /v1/batches/{batch_id}/items
openapi: 3.0.3
info:
title: Batches-API
version: 1.0.0
servers:
- url: https://api.olostep.com
security: []
paths:
/v1/batches/{batch_id}/items:
get:
summary: >-
Abgeschlossene oder fehlgeschlagene Elementeliste optional mit Inhalt
für einen bestimmten Batch abrufen
description: >-
Ruft die Liste der Elemente und Inhalte gemäß dem angeforderten Status
für eine bestimmte Batch-ID ab.
parameters:
- name: batch_id
in: path
required: true
schema:
type: string
description: Die ID des Batches, für den Elemente abgerufen werden sollen.
- name: status
in: query
required: false
schema:
type: string
enum:
- completed
- failed
description: >-
Status der URLs, die abgerufen werden sollen (completed oder
failed).
- name: cursor
in: query
required: false
schema:
type: integer
description: >-
Paginierungscursor. Lass diesen Parameter bei der ersten Anfrage
weg. Für nachfolgende Anfragen verwende den `cursor`-Wert aus der
vorherigen Antwort. Siehe
[Pagination](/api-reference/common/pagination) für Details.
- name: limit
in: query
required: false
schema:
type: integer
description: Anzahl der zurückzugebenden Ergebnisse (empfohlen 10-50).
responses:
'200':
description: Erfolgreiche Antwort mit Batch-Elementen.
content:
application/json:
schema:
type: object
properties:
batch_id:
type: string
object:
type: string
status:
type: string
items:
type: array
items:
type: object
properties:
custom_id:
type: string
retrieve_id:
type: string
url:
type: string
metadata:
allOf:
- $ref: '#/components/schemas/Metadata'
description: >-
Elementbezogene Metadaten, wenn sie während der
Batch-Erstellung bereitgestellt wurden.
links_on_page:
type: array
items:
type: string
items_count:
type: integer
cursor:
type: integer
description: >-
Paginierungscursor. Vorhanden, wenn weitere Ergebnisse
verfügbar sind. Verwende diesen Wert im `cursor`-Parameter
der nächsten Anfrage. Siehe
[Paginierung](/api-reference/common/pagination) für
Details.
example:
batch_id: batch_abc123def456
object: list
status: completed
items:
- custom_id: product-123
retrieve_id: ret_xyz789
url: https://example.com/product/123
metadata:
source: catalog_sync
priority: high
- custom_id: product-456
retrieve_id: ret_abc456
url: https://example.com/product/456
items_count: 2
'400':
description: >-
Ungültige Anfrage aufgrund falscher Parameter. Siehe [Ungültige
Anfrage](/api-reference/errors/bad_request) für Details.
content:
application/problem+json:
schema:
$ref: '#/components/schemas/Error'
example:
id: error_abc123
object: error
code: validation_error
type: https://docs.olostep.com/api-reference/errors/bad_request
status: 400
title: Ungültige Anfrage
detail: Status must be either 'completed' or 'failed'
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.
````