> ## 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.
# Mettre à jour un lot
> Met à jour les métadonnées pour un lot spécifique. Seules les métadonnées peuvent être mises à jour après la création du lot.
**Sémantique de fusion :** Les mises à jour des métadonnées suivent l'approche de Stripe — les nouvelles clés sont ajoutées, les clés existantes sont mises à jour, et les clés définies sur une chaîne vide `""` sont supprimées.
## OpenAPI
````yaml fr/openapi/batches.json PATCH /v1/batches/{batch_id}
openapi: 3.0.3
info:
title: API des lots
version: 1.0.0
servers:
- url: https://api.olostep.com
security: []
paths:
/v1/batches/{batch_id}:
patch:
summary: Mettre à jour les métadonnées du lot
description: >-
Met à jour les métadonnées pour un lot spécifique. Seul le champ
`metadata` peut être mis à jour. Suit la sémantique de fusion de Stripe
: les nouvelles clés sont ajoutées, les clés existantes sont mises à
jour, et les clés définies sur une chaîne vide sont supprimées.
parameters:
- name: batch_id
in: path
required: true
schema:
type: string
description: L'ID du lot à mettre à jour.
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: Métadonnées du lot mises à jour avec succès.
content:
application/json:
schema:
type: object
properties:
id:
type: string
description: ID du lot
object:
type: string
description: Le type d'objet. "batch" pour ce point de terminaison.
status:
type: string
description: '`in_progress` ou `completed`'
created:
type: number
description: Époque créée
total_urls:
type: number
description: Nombre d'URLs dans le lot
completed_urls:
type: number
description: Nombre d'URLs complétées
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: >-
Mauvaise requête - métadonnées manquantes ou invalides. Voir
[Mauvaise Requête](/api-reference/errors/bad_request) pour plus de
détails.
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: Mauvaise Requête
detail: No metadata field provided. Only metadata can be updated.
created: 1704067200
metadata: {}
'401':
description: >-
Les informations d'authentification sont manquantes ou invalides.
Voir [Non autorisé](/api-reference/errors/unauthorized) pour plus de
détails.
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: Non autorisé
detail: Your API key is invalid
created: 1704067200
metadata: {}
'404':
description: >-
Lot non trouvé pour l'ID fourni. Voir [Non
Trouvé](/api-reference/errors/not_found) pour plus de détails.
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: Non Trouvé
detail: Batch not found
created: 1704067200
metadata: {}
'500':
description: >-
Erreur interne du serveur. Voir [Erreur
interne](/api-reference/errors/internal_error) pour plus de détails.
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: Erreur interne du serveur
detail: An unexpected error occurred
created: 1704067200
metadata: {}
security:
- Authorization: []
components:
schemas:
Metadata:
type: object
description: >-
Ensemble de paires clé-valeur pour stocker des informations
supplémentaires sur un objet. Suit l'approche de Stripe avec des règles
de validation : max 50 clés, clé max 40 caractères (pas de crochets),
valeur max 500 caractères, toutes les valeurs stockées en tant que
chaînes.
additionalProperties:
type: string
maxLength: 500
description: >-
Valeur des métadonnées (max 500 caractères). Les nombres et les
booléens sont automatiquement convertis en chaînes.
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: Réponse d'erreur RFC 7807 Détails du Problème
properties:
id:
type: string
description: Identifiant unique de l'erreur
object:
type: string
enum:
- error
description: Toujours 'error'
code:
type: string
description: Code d'erreur lisible par machine
type:
type: string
format: uri
description: Référence URI identifiant le type de problème
status:
type: integer
description: Code de statut HTTP
title:
type: string
description: Résumé court et lisible par un humain
detail:
type: string
description: Explication lisible par un humain
created:
type: integer
description: Horodatage Unix
metadata:
$ref: '#/components/schemas/Metadata'
errors:
type: array
description: Tableau optionnel de détails d'erreur supplémentaires
items: {}
required:
- id
- object
- code
- type
- status
- title
- detail
- created
securitySchemes:
Authorization:
type: http
scheme: bearer
description: >-
En-tête d'authentification Bearer sous la forme Bearer , où
est ton jeton d'authentification.
````