Obtenir le document de résultat
Cette section :
•L’URI du document de résultat
•Récupérer le document de résultat
•Document de résultat contenant les URI des documents d'erreur
•Document de résultat contenant les URI des documents de sortie
•Document de résultat ne contenant aucun URI
•Accéder aux documents d'erreur et de sortie répertoriés dans le document de résultat
L’URI du document de résultat
Un document de résultat sera créé à chaque fois qu'une tâche est créée, que le résultat d'une tâche (par exemple, une validation) soit positif (document valide) ou négatif (document non valide). Dans les deux cas, un message 201 Created est renvoyé. Ce message sera au format JSON et contiendra un URI relatif du document de résultat. Le fragment JSON ressemblera à ceci :
{
"result": "/v1/results/E6C4262D-8ADB-49CB-8693-990DF79EABEB",
"jobid": "E6C4262D-8ADB-49CB-8693-990DF79EABEB"
}
L'objet result contient l'URI relative du document de résultat. L'URI est relative à l'adresse du serveur. Par exemple, si l'adresse du serveur est http://localhost:8087/ (l'adresse de configuration initiale), l'URI développée du document de résultat spécifié dans la liste ci-dessus sera :
http://localhost:8087/v1/results/E6C4262D-8ADB-49CB-8693-990DF79EABEB
Note : le numéro de version correct /vN est celui renvoyé par le serveur (et n'est pas nécessairement celui indiqué dans cette documentation). Le numéro renvoyé par le serveur correspond au numéro de version de l'API HTTP actuelle. Les numéros de version précédents indiquent les anciennes versions de l'API HTTP, qui sont toutefois toujours prises en charge pour des raisons de compatibilité ascendante.
Récupérer le document de résultat
Pour obtenir le document de résultat, soumettez l'URI étendu du document (voir ci-dessus) dans une requête HTTP GET. Le document de résultat est renvoyé et peut être l'un des types génériques décrits ci-dessous.
Note : lorsqu'une tâche est placée avec succès dans la file d'attente du serveur, celui-ci renvoie l'URI du document de résultat. Si le client demande le résultat avant que la tâche ait été lancée (elle est encore dans la file d'attente), un message "status": "Dispatched" sera renvoyé. Si la tâche a été lancée, mais n'est pas terminée (par exemple, parce qu'il s'agit d'une tâche volumineuse), un message "status": "Running" sera renvoyé. Dans ces deux situations, le client doit patienter un certain temps avant d'envoyer une nouvelle demande pour le document de résultat.
Note : les exemples de documents ci-dessous supposent tous un accès client restreint. Les documents d'erreur, les documents de message et les documents de sortie sont donc tous supposés être enregistrés dans le répertoire de tâches correspondant sur le serveur. Les URI qui les concernent dans le document de résultat sont donc toutes des URI relatives. Aucune n'est une URI de fichier (qui serait le type d'URI généré en cas d'accès client illimité). Pour plus de détails sur ces URI, voir la section Obtenir documents d’erreur/de message/de sortie.
Document de résultat contenant les URI des documents d'erreur
Si la tâche demandée s'est terminée avec un état Failed, alors la tâche a renvoyé un résultat négatif. Par exemple, une tâche de validation a renvoyé un résultat « document invalide ». Les erreurs rencontrées lors de l'exécution de la tâche sont stockées dans des journaux d'erreurs, créés dans trois formats de fichier : (i) texte, (ii) XML long (journal d'erreurs détaillé) et (iii) XML court (journal d'erreurs moins détaillé). Voir la liste JSON ci-dessous.
{
"jobid": "6B4EE31B-FAC9-4834-B50A-582FABF47B58",
"state": "Failed",
"error":
{
"text": "/v1/results/6B4EE31B-FAC9-4834-B50A-582FABF47B58/error/error.txt",
"longxml": "/v1/results/6B4EE31B-FAC9-4834-B50A-582FABF47B58/error/long.xml",
"shortxml": "/v1/results/6B4EE31B-FAC9-4834-B50A-582FABF47B58/error/short.xml"
},
"jobs":
[
{
"file": "file:///c:/Test/ExpReport.xml",
"jobid": "20008201-219F-4790-BB59-C091C276FED2",
"output":
{
},
"state": "Failed",
"error":
{
"text": "/v1/results/20008201-219F-4790-BB59-C091C276FED2/error/error.txt",
"longxml": "/v1/results/20008201-219F-4790-BB59-C091C276FED2/error/long.xml",
"shortxml": "/v1/results/20008201-219F-4790-BB59-C091C276FED2/error/short.xml"
}
}
]
}
Veuillez noter les points suivants :
•Les tâches comportent des sous-tâches.
•Les erreurs au niveau des sous-tâches se propagent jusqu'à la tâche de niveau supérieur. L'état de la tâche de niveau supérieur ne sera OK que si toutes ses sous-tâches ont un état OK.
•Chaque tâche ou sous-tâche dispose de son propre journal d'erreurs.
•Les journaux d'erreurs incluent les journaux d'avertissements. Ainsi, même si une tâche se termine avec un état OK, elle peut comporter des URI de fichiers d'erreurs.
•Les URI des fichiers d'erreur sont relatifs à l'adresse du serveur (voir ci-dessus).
Document de résultat contenant les URI des documents de sortie
Si la tâche demandée s'est terminée avec un état OK, alors la tâche a renvoyé un résultat positif. Par exemple, une tâche de validation a renvoyé un résultat « document valide ». Si la tâche a produit un document de sortie, par exemple le résultat d'une transformation XSLT, l'URI du document de sortie est renvoyé. Voir la liste JSON ci-dessous.
{
"jobid": "5E47A3E9-D229-42F9-83B4-CC11F8366466",
"state": "OK",
"error":
{
},
"jobs":
[
{
"file": "file:///c:/Test/SimpleExample.xml",
"jobid": "D34B5684-C6FF-4A7A-BF35-EBB9A8A8C2C8",
"output":
{
"xslt-output-file":
[
"/v1/results/D34B5684-C6FF-4A7A-BF35-EBB9A8A8C2C8/output/1"
]
},
"state": "OK",
"output-mapping":
{
"/v1/results/D34B5684-C6FF-4A7A-BF35-EBB9A8A8C2C8/output/1": "file:///c:/temp/test.html"
},
"error":
{
}
}
]
}
Veuillez noter les points suivants :
•Le fichier de sortie est créé dans le dossier output de la tâche. Vous pouvez utiliser son URI relatif pour accéder au fichier.
•Les URI des fichiers de sortie sont relatifs à l'adresse du serveur (voir ci-dessus).
•L'élément output-mapping mappe le document de sortie dans le répertoire de tâches sur le serveur à l'emplacement du fichier spécifié par le client dans la demande de tâche. Notez que seuls les documents de sortie spécifiés par le client dans la demande de tâche ont un mappage ; les fichiers liés à la tâche générés par le serveur (tels que les fichiers d'erreur) n'ont pas de mappage.
•Il est également possible de récupérer tous les documents de résultat générés pour une tâche spécifique sous forme d'archive zip à l'aide de l'URL "/v1/results/JOBID/output/zip". Cette fonctionnalité n'est pas disponible en mode système de fichiers sans restriction. Veuillez noter que l'archive zip contiendra des noms de fichiers modifiés, qui devront être remappés vers leurs noms réels à l'aide de l'objet output-mapping.
Document de résultat ne contenant aucun URI
Si la tâche demandée s'est terminée avec un état OK, alors la tâche a renvoyé un résultat positif. Par exemple, une tâche de validation a renvoyé un résultat « document valide ». Certaines tâches, telles que la validation ou le test de conformité, ne génèrent aucun document de sortie. Si une tâche de ce type se termine avec un état OK, le document de résultat ne comportera ni l'URI d'un document de sortie ni l'URI d'un journal d'erreurs. Voir la liste JSON ci-dessous.
{
"jobid": "3FC8B90E-A2E5-427B-B9E9-27CB7BB6B405",
"state": "OK",
"error":
{
},
"jobs":
[
{
"file": "file:///c:/Test/SimpleExample.xml",
"jobid": "532F14A9-F9F8-4FED-BCDA-16A17A848FEA",
"output":
{
},
"state": "OK",
"error":
{
}
}
]
}
Veuillez noter les points suivants :
•Les composants de sortie et d'erreur de la sous-tâche dans la liste ci-dessus sont vides.
•Une tâche peut se terminer avec un état OK, mais contenir néanmoins des avertissements ou d'autres messages, qui sont consignés dans des fichiers d'erreurs. Dans ce cas, le document de résultat contiendra les URI des fichiers d'erreurs, même si la tâche s'est terminée avec un état OK.
Accéder aux documents d'erreur et de sortie répertoriés dans le document de résultat
Les documents d'erreur et de sortie sont accessibles via des requêtes HTTP GET. Ces dernières sont décrites dans la section suivante, Obtenir les documents d'erreur/sortie.