> ## 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 Bijwerken
> Werkt de metadata voor een specifieke batch bij. Alleen metadata kan worden bijgewerkt na het aanmaken van de batch.
**Merge-semantieken:** Metadata-updates volgen de aanpak van Stripe — nieuwe sleutels worden toegevoegd, bestaande sleutels worden bijgewerkt, en sleutels die op een lege string `""` zijn gezet, worden verwijderd.
## OpenAPI
````yaml nl/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: Batchmetadata bijwerken
description: >-
Werkt de metadata bij voor een specifieke batch. Alleen het veld
`metadata` kan worden bijgewerkt. Volgt de merge-semantiek van Stripe:
nieuwe sleutels worden toegevoegd, bestaande sleutels worden bijgewerkt,
en sleutels die op een lege string zijn ingesteld, worden verwijderd.
parameters:
- name: batch_id
in: path
required: true
schema:
type: string
description: De ID van de batch die je wilt bijwerken.
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: Batchmetadata succesvol bijgewerkt.
content:
application/json:
schema:
type: object
properties:
id:
type: string
description: Batch ID
object:
type: string
description: Het soort object. "batch" voor dit endpoint.
status:
type: string
description: '`in_progress` of `completed`'
created:
type: number
description: Gemaakt epoch
total_urls:
type: number
description: Aantal URLs in de batch
completed_urls:
type: number
description: Aantal voltooide 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: >-
Fout in verzoek - ontbrekende of ongeldige metadata. Zie [Bad
Request](/api-reference/errors/bad_request) voor 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: Slecht Verzoek
detail: No metadata field provided. Only metadata can be updated.
created: 1704067200
metadata: {}
'401':
description: >-
Authenticatiegegevens ontbreken of zijn ongeldig. Zie
[Unauthorized](/api-reference/errors/unauthorized) voor 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: Niet geautoriseerd
detail: Your API key is invalid
created: 1704067200
metadata: {}
'404':
description: >-
Batch niet gevonden voor de opgegeven ID. Zie [Not
Found](/api-reference/errors/not_found) voor 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: Niet Gevonden
detail: Batch not found
created: 1704067200
metadata: {}
'500':
description: >-
Interne serverfout. Zie [Internal
Error](/api-reference/errors/internal_error) voor 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: Interne Serverfout
detail: An unexpected error occurred
created: 1704067200
metadata: {}
security:
- Authorization: []
components:
schemas:
Metadata:
type: object
description: >-
Set van sleutel-waarde paren voor het opslaan van aanvullende informatie
over een object. Volgt Stripe's aanpak met validatieregels: max 50
sleutels, sleutel max 40 tekens (geen vierkante haken), waarde max 500
tekens, alle waarden opgeslagen als strings.
additionalProperties:
type: string
maxLength: 500
description: >-
Metadata waarde (max 500 tekens). Nummers en booleans worden
automatisch omgezet naar strings.
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 Probleem Details foutrespons
properties:
id:
type: string
description: Unieke foutidentificatie
object:
type: string
enum:
- error
description: Altijd 'error'
code:
type: string
description: Machine-leesbare foutcode
type:
type: string
format: uri
description: URI referentie die het probleemtype identificeert
status:
type: integer
description: HTTP statuscode
title:
type: string
description: Korte, mens-leesbare samenvatting
detail:
type: string
description: Mens-leesbare uitleg
created:
type: integer
description: Unix tijdstempel
metadata:
$ref: '#/components/schemas/Metadata'
errors:
type: array
description: Optionele array van aanvullende foutdetails
items: {}
required:
- id
- object
- code
- type
- status
- title
- detail
- created
securitySchemes:
Authorization:
type: http
scheme: bearer
description: >-
Bearer authenticatie header in de vorm Bearer , waar jouw
auth token is.
````