Obtenir le statut d'une opération en masse

GET

https://api-v2.test.eldowallet.fr/bulk-operations/:operationId

Renvoie l'état d'avancement et les résultats d'une opération en masse lancée par votre wallet (envoi, mise à jour ou suppression en masse). Interrogez cette route avec l'operationId renvoyé au lancement jusqu'à ce que status vaille completed ou failed.

À retenir

• status passe de pending à processing, puis à completed ou failed. completed ne signifie pas que tous les éléments ont réussi : vérifiez failureCount et operationErrors. Si vous avez fourni un webhookUrl au lancement, il est appelé quand l'opération atteint completed.

Requête

path parameters

• operationId string required
  Identifiant de l'opération en masse, renvoyé par la requête qui l'a lancée.
  example: 507f1f77bcf86cd799439011

header parameters

• x-lang string
  Langue des messages d'erreur et des textes renvoyés : `fr` ou `en`.
  enum: en, frdefault: "en"

Réponses

200

Schéma application/json

• operationId string required
  Identifiant unique de l'opération en masse.
  example: 507f1f77bcf86cd799439011
• totalItems number required
  Nombre total d'éléments de l'opération.
  example: 100
• successCount number required
  Nombre d'éléments traités avec succès.
  example: 95
• failureCount number required
  Nombre d'éléments en échec.
  example: 5
• status string required
  Current status of the operation
  enum: pending, processing, completed, failedexample: pending
• operationErrors object[]
  Liste des erreurs des éléments en échec.
  • itemId string required
    Identifiant de l'élément en échec.
    example: 507f1f77bcf86cd799439011
  • message string required
    Message d'erreur.
    example: Client not found
  • code string
    Code d'erreur, s'il est disponible.
    example: 404:MODEL_NOT_FOUND
• results object[]
  Liste des résultats des éléments traités avec succès.
  • itemId string required
    Identifiant de l'élément.
    example: 507f1f77bcf86cd799439011
  • result object
    Données du résultat.
• createdAt string <date-time> required
  Date et heure de création de l'opération.
  example: 2024-01-01T00:00:00.000Z
• completedAt string <date-time>
  Date et heure de fin de l'opération.
  example: 2024-01-01T00:05:00.000Z

401

UNAUTHORIZED

Schéma application/json

• message string requiredexample: Promo code already exists
• errorCode string requiredexample: 400:PROMO_CODE_ALREADY_EXISTS
• path string requiredexample: /coupons
• date string <date-time> required
• details object
• validationErrors object[]
  • field stringexample: email
  • message stringexample: email must be an email

403

FORBIDDEN

Schéma application/json

• message string requiredexample: Promo code already exists
• errorCode string requiredexample: 400:PROMO_CODE_ALREADY_EXISTS
• path string requiredexample: /coupons
• date string <date-time> required
• details object
• validationErrors object[]
  • field stringexample: email
  • message stringexample: email must be an email

500

UNKNOWN_ERROR

Schéma application/json

• message string requiredexample: Promo code already exists
• errorCode string requiredexample: 400:PROMO_CODE_ALREADY_EXISTS
• path string requiredexample: /coupons
• date string <date-time> required
• details object
• validationErrors object[]
  • field stringexample: email
  • message stringexample: email must be an email