Ce service Web permet d'exécuter l'étape Transform de l'APE.

Format du message en entrée

Le format du message JSON en entrée est le suivant :

{

"xslfoDoc": "string",

"outputMimeType": "string",

"options": {

"docDescription": {

"author": "string",

"creationDate": "2018-12-03T15:06:09.729Z",

"creator": "string",

"keywords": "string",

"producer": "string",

"subject": "string",

"title": "string"

},

"pdfDocPolicy": {

"allowAccessContent": "string",

"allowAssembleDocument": "string",

"allowCopyContent": "string",

"allowEditAnnotations": "string",

"allowEditContent": "string",

"allowFillInForms": "string",

"allowPrint": "string",

"allowPrintHq": "string",

"encryptMetadata": "string",

"ownerPassword": "string",

"userPassword": "string"

}

}

}

Lorsque le service Web s'exécute sans erreur, le code HTTP retourné est 200 et la réponse est un document dans le format d'édition demandé.

En cas d'erreur, le code HTTP retourné est soit 400, si le corps de la requête est incorrect, soit 500 lors d'une erreur dans le traitement du template. En cas d'erreur, la réponse retournée est de type JSON.

↑ Haut de page

Attributs

Le message doit représenter un objet JSON avec les attributs suivants :

xslfoDoc

Cet attribut est obligatoire et de type String. Il représente le contenu d'un document XSL-FO final. Cf. section "Langage XSL-FO" dans "Apache FOP".

outputMimeType

Cet attribut est obligatoire et de type String. Il représente le type MIME correspondant au format d'édition du document résultat à produire. Cf. section "Formats d'édition" dans "Apache FOP".

options

Cet attribut est optionnel et de type Objet. Il représente les paramètres supplémentaires à prendre en compte lors de la transformation du document XSL-FO. L'ensemble des options sont décrites dans un objet JSON dont chaque membre décrit une option, à savoir :

docDescription : option de définition de métadonnées stockées dans le document résultat (valeur de type JSON Object). Cette option ne peut être utilisée qu'avec certains formats de sortie autorisant le stockage de métadonnées. Actuellement, le moteur Apache FOP implémente le support des métadonnées seulement pour le format "application/pdf ".
pdfDocPolicy : option de définition de la politique de droits d'un document au format "application/pdf" (valeur de type JSON array of Object). Cela regroupe les fonctions de protection par mot de passe, les autorisations d'impression, etc.

Métadonnées d'un document

L'attribut "docDescription" regroupe, dans un objet JSON, un ensemble de métadonnées à fixer pour un document.

Chaque métadonnée (optionnelle) est stockée dans un attribut, à savoir :

- "author" (chaîne alphanumérique) : désignation de l'auteur du document,
- "creationDate" (chaîne alphanumérique au format ISO 8601 correspondant à un horodatage) : date et heure de création du document (remplace la date à laquelle le document a été créé),
- "creator" (chaîne alphanumérique) : désignation du créateur du document (valeur par défaut : "Apache FOP Version 2.2 "),
- "keywords" (chaîne alphanumérique) : mots-clés associés au document,
- "producer" (chaîne alphanumérique) : désignation du système (ou de l'application) qui a produit ce document (valeur par défaut : "Apache FOP Version 2.2 "),
- "subject" (chaîne alphanumérique) : sujet du document,
- "title" (chaîne alphanumérique) titre du document.

Politique de droits d'un document

Pour un document au format PDF, l'attribut "pdfDocPolicy" regroupe, dans un objet JSON, un ensemble de droits d'usage applicables à la manipulation du document. Chaque droit (optionnel) est stocké dans un attribut, à savoir :

- "userPassword" (chaîne alphanumérique non vide) : mot de passe d'ouverture du document. Lors de l'utilisation d'un document par un lecteur de document (Acrobat Reader par exemple), ce mot de passe sera demandé pour pouvoir visualiser son contenu. Il n'est pas possible d'ouvrir un document PDF sans connaitre le "userPassword" quel que soit le lecteur PDF utilisé (Acrobat Reader, Foxit Reader, etc.),
- "ownerPassword" (chaîne alphanumérique non vide) : mot de passe d'accès aux droits du document. Il contrôle les autorisations, telles que l'impression, la modification, l'extraction, les commentaires, etc. Le lecteur interdit ces opérations en fonction des paramètres d'autorisation. Celui-ci vous demandera ce mot de passe si vous souhaitez définir ou modifier les autorisations pour ce document,
- "allowPrint" (chaîne alphanumérique "true" ou "false ") : indique l'autorisation d'imprimer le document PDF à partir d'un lecteur (autorisé par défaut),
- "allowPrintHq" (chaîne alphanumérique "true" ou "false ") : indique l'autorisation d'imprimer le document PDF en haute résolution à partir d'un lecteur (autorisé par défaut),
- "allowCopyContent" (chaîne alphanumérique "true" ou "false ") : indique l'autorisation de copier le contenu du document dans le presse-papier à partir d'un lecteur (autorisé par défaut),
- "allowEditContent" (chaîne alphanumérique "true" ou "false ") : indique l'autorisation d'éditer le contenu du document à partir d'un lecteur (autorisé par défaut),
- "allowAccessContent" (chaîne alphanumérique "true" ou "false ") : indique l'autorisation d'extraire le texte et les images du document à partir d'un lecteur (non autorisé par défaut),
- "allowAssembleDocument" (chaîne alphanumérique "true" ou "false ") : indique l'autorisation d'assembler les pages du document à partir d'un lecteur (non autorisé par défaut),
- "allowFillInForms" (chaîne alphanumérique "true" ou "false ") : indique l'autorisation de remplir les champs de formulaires du document à partir d'un lecteur (autorisé par défaut),
- "allowEditAnnotations" (chaîne alphanumérique "true" ou "false ") : indique l'autorisation d'éditer les annotations (commentaires) du document à partir d'un lecteur (autorisé par défaut),
- "encryptMetadata" (chaîne alphanumérique "true" ou "false ") : indique s'il faut encrypter les métadonnées (vrai par défaut).