Passer au contenu principal
Pour échanger des fichiers avec le serveur d’applications, utilisez une requête POST. Avant d’envoyer des requêtes de fichiers, connectez-vous à l’API Web Services. Pour plus d’informations, consultez Se connecter à l’API Web Services.

Types d’actions

Utilisez des requêtes POST pour effectuer les actions suivantes :

Cas d’utilisation courants

  • Importer des images : charger des fichiers image, y compris en plusieurs parties, et obtenir leur somme de contrôle.
  • Obtenir à tout moment du traitement les images des pages d’origine.
  • Travailler avec les pièces jointes des lots, des documents et des pages (téléversement et téléchargement).
  • Obtenir la description XML d’une tâche de vérification, modifier le document et enregistrer les modifications sur le serveur.

Paramètres de la requête

Une requête de fichier utilise les paramètres suivants.

Types d’objet

Le paramètre objectType accepte les valeurs suivantes : Le type d’objet 8 (pièce jointe de tâche) est particulièrement adapté aux pièces jointes volumineuses, qui sont divisées en parties plus petites et téléversées vers le serveur. Après une requête POST qui ajoute une pièce jointe à un objet, appelez la méthode SaveAttachment en transmettant comme paramètre file un fichier de longueur nulle dont le nom correspond au fichier transféré. Dans les autres cas, utilisez les méthodes Pièces jointes, spécialement conçues pour les pièces jointes. Pour les fichiers de type d’objet 13, définissez projectId sur 0 et batchId sur 0, car ces fichiers n’appartiennent à aucun projet, lot ou tenant. Pour écrire un fichier de ce type, l’administrateur doit ouvrir une session. Pour lire un fichier de ce type, indiquez sessionId=0 ; il n’est pas nécessaire d’ouvrir une session.

Noms de flux

Le paramètre streamName correspond au nom du flux binaire. Utilisez l’encodage Base64 lors de l’enregistrement d’un fichier sur le serveur, et l’encodage UrlEncode lors du chargement d’un fichier depuis le serveur. Les valeurs disponibles dépendent du type d’objet.

Noms des flux de page

Noms des flux de document

Noms des flux de tâches

  • Verification – Un document XML qui décrit une tâche de vérification. Il est créé lors de la préparation de la tâche pour les stations Web. Après la vérification, les modifications apportées au document sont traitées. Les versions ne sont pas prises en charge ; définissez le paramètre version sur 1. Enregistrez les résultats du traitement de la tâche dans ce fichier.
  • VerificationRequest – Correspond à l’une des requêtes suivantes :
    • Un document XML qui contient une requête visant à exécuter des opérations dans un lot, y compris la séparation des documents et la réorganisation des pages. Ce type de requête est utilisé par la station Web pour la vérification des règles.
    • Un document XML contenant une requête de routage.
    • Un document XML contenant une requête d’extrapolation de LineItems.
    • Un document XML contenant une requête de vérification des données.

Stockage de fichiers

Le stockage de fichiers contient l’ensemble des fichiers du projet. Le nom du fichier encode le type d’objet, l’identifiant de l’objet et le nom du flux sous la forme <object type>-<object id>-<stream name>version. Les fichiers de page (objectType = 1) contiennent des copies d’images, tandis que les fichiers de document (objectType = 0) contiennent les images source. Pour cette raison, vous ne pouvez pas modifier une image au moyen d’une requête POST avec objectType = 1.

Exemples de requêtes

Chargement d’un fichier depuis le serveur

Pour charger un fichier de page (objectType = 1) ayant id=4, streamName=C:\Temp\image.pdf et version=184201843 depuis le serveur, utilisez la requête POST suivante :

Enregistrer un fichier sur le serveur

Pour enregistrer un document (objectType = 0) avec id=4, projectId=3, batchId=6, version=522 et streamName=C:\Temp\image.pdf sur le serveur, utilisez la requête POST suivante :
Pour plus d’informations, consultez Examples.