Suivre l'activation ou la désactivation Cegid Loop APIs Standard

Présentation générale de l'API et finalité fonctionnelle

Cette API retourne l'avancement d'une activation ou d'une désactivation démarrée par activateStandardAPI ou deactivateStandardAPI. Les enregistrements de suivi sont conservés.

GET/getStandardAPIProgressStatus

Lien vers la documentation technique

Cas d'usage

• Suivre une activation ou une désactivation asynchrone à l'aide du jobId.
• Savoir si le job est encore en cours (inProgress) ou terminé (completed / failed).

Procédure

Interroger périodiquement l'endpoint jusqu'à ce que status vaille completed ou failed (success + failed = total).

https://api.cegid.com/loop-api-publiques/getStandardAPIProgressStatus?jobId={jobId}

Route	Méthode http	Description
/getStandardAPIProgressStatus	GET	Retourne l'avancement d'une tâche d'activation ou de désactivation

Paramétrage de l'appel

Méthode http pour la demande : GET

Header(s) attendu(s) obligatoire(s) de la demande

Champ	Description
Ocp-Apim-Subscription-Key	Subscription key
x-apikey	API Key & Secret

Paramètres de la demande

Champ	Type	Description	Obligatoire
jobId	string	Identifiant de tâche retourné par activateStandardAPI ou deactivateStandardAPI	Oui

Exemple

GET /getStandardAPIProgressStatus?jobId=3fa85f64-5717-4562-b3fc-2c963f66afa6

Code retour

En cas de succès

Code retour http de la réponse : 200

En cas d'échec

Code HTTP	Description
404	Tâche introuvable

Lien vers la liste des codes d'erreur

Structure du retour

Champ	Type	Description
total	integer	Nombre total de dossiers à traiter
success	integer	Nombre de dossiers traités avec succès
failed	integer	Nombre de dossiers en échec
details	array	Détail du résultat par dossier
details[].codeIbs	string	Code du dossier
details[].status	string	success ou failed
details[].reason	string	Raison de l'échec (Max retries reached: ... lorsque les tentatives sont épuisées)
type	string	addApplicationAndWorkGroupToDossier ou removeApplicationAndWorkGroupFromDossier
status	string	inProgress tant que des dossiers restent à traiter, completed si tous ont réussi, failed si le job est terminé avec au moins un échec

Exemple de retour

{
    "total": 10,
    "success": 8,
    "failed": 2,
    "details": [
        {
            "codeIbs": "CEGID001",
            "status": "success"
        },
        {
            "codeIbs": "CEGID002",
            "status": "failed",
            "reason": "Dossier not found"
        }
    ],
    "type": "addApplicationAndWorkGroupToDossier",
    "status": "failed"
}