Réponse de serveur à une requête POST
Cette section :
•Aperçu des réponses de serveur possibles
•Réponse : Échec de la requête, aucune réponse du serveur
•Réponse : Requête communiquée, mais la tâche est rejetée par le serveur
•Réponse : Tâche exécutée (avec un résultat positif ou négatif)
Lorsqu'une requête POST est effectuée avec succès auprès du serveur, la tâche est placée dans la file d'attente du serveur. Un message 201 Created et un URI de document de résultat sont retournés. La tâche sera traitée au plus tôt. Entre-temps, si le document de résultat est requis, un message "status": Le message "Running" est retourné si la tâche a démarré mais n'a pas été terminée ; le client devra essayer à nouveau plus tard. Un état Dispatched indique que la tâche se trouve dans la file d'attente du serveur mais n'a pas encore été démarrée.
Le résultat de la tâche (par exemple, une requête de validation) peut être négative (échec de la validation) ou positive (validation réussie). Dans les deux cas, un message 201 Created est retourné et un document de résultat est généré. Il est également possible que la requête POST n'ait pas été communiquée au serveur (Échec de la requête), ou bien, la requête a été communiquée mais la tâche a été rejetée par le serveur (Requête communiquée, mais tâche rejetée). Les différents résultats possibles sont montrés dans le diagramme ci-dessous.
Échec de la requête, aucune réponse du serveur
En cas d'échec de requête sur le serveur, les erreurs les plus communes sont les suivantes :
Message | Explication |
404 Introuvable | Le chemin correct est : http://localhost:8087/v1/queue/ |
405 Méthode non autorisée | La méthode spécifiée est invalide pour cette ressource. Utiliser la méthode POST. |
415 Format de requête non pris en charge | L'en-tête de message doit être Content-Type:application/json. |
Requête communiquée, mais la tâche est rejetée par le serveur
Lorsque les requêtes sont effectuées avec succès sur le serveur, celui-ci peut les rejeter pour les raisons suivantes :
Message | Explication |
400 Bad Request (bad cmd) | La commande RaptorXML est incorrecte. |
400 Bad Request (json error) | Le corps de requête contient une erreur de syntaxe JSON. |
404 File Not Found | Contrôler syntaxe d'URI de fichier (ou chemin de fichier) de tous les fichiers nommés dans la commande. |
Tâche exécutée (avec un résultat positif ou négatif)
Lorsqu'une tâche (par exemple, une tâche de validation) est exécutée, son résultat peut être positif (OK) ou négatif (Échec). Par exemple, le résultat d'une tâche de validation est positif (OK) lorsque le document à valider est valide, négatif (Échec) si le document est invalide.
Dans les deux cas, la tâche est exécutée, mais avec des résultats différents. Un message 201 Created est retourné dans les deux cas dès que la tâche a été placée avec succès dans la file d'attente. De même, dans les deux cas, un URI de document de résultat est retourné vers le client HTTP qui a effectué la requête. Après avoir créé le document de résultat, il peut être récupéré avec une requête HTTP GET.
Le document de résultat lui-même n’a peut-être pas encore été créé si la tâche n’a pas encore été démarrée ou terminée. Si le document de résultat est demandé à ce moment-là, un message « statut » : "Running" est retourné si la tâche a été démarrée mais pas encore terminée ; un statut Dispatched indique que la tâche se trouve dans le serveur mais pas encore été lancée.
En plus du document de résultat, d’autres documents peuvent être générés, comme suit :
•Tâche exécutée avec le résultat « Échec » : Un journal d’erreur est créé dans trois formats : texte, XML long et XML court. Les URI de ces trois documents sont envoyés dans le document de résultat (qui est en format JSON). Les URI peuvent ensuite être utilisés dans une requête GETpour aller chercher les documents d’erreur.
•Tâche exécutée avec le résultat « OK » : La tâche est traitée avec succès et les documents de sortie —tels que la sortie produite par une transformation XSLT —sont créés. Si des fichiers de sortie ont été générés, leurs URI sont envoyés dans le document de résultat de format JSON. Les URI peuvent ensuite être utilisés dans une requête GET HTTP pour aller chercher les documents de sortie. Veuillez noter que toutes les tâches n'auront pas forcément de fichiers de sortie ; par exemple, une tâche de validation. Ainsi, une tâche peut se terminer avec un état 'OK', mais il peut s'être produit des avertissements et/ou des messages qui ont été rédigés des fichiers d'erreur. Dans ce cas, les URI de fichier d'erreur sont aussi envoyés dans le document de résultat (c'est à dire, en plus des documents de sortie).
Voir Obtenir le document de résultat et Obtenir les documents d'erreur/sortie pour une description de ces documents et de leur accès.