API REST pour travailler avec des mappages DITA id175UB30E05Z

L’API REST suivante vous permet d’utiliser des mappages DITA dans AEM Guides.

Téléchargement du mappage DITA avec des dépendances

Méthode de GET qui télécharge un mappage DITA avec toutes ses dépendances, telles que les rubriques référencées, les sous-cartes, les images et les DTD utilisées dans le mappage et les rubriques.

URL de la requête: http://<aem-guides-server>: <port-number>/bin/fmdita/exportditamap

Paramètres: |Nom|Type|Obligatoire|Description| |—|—|—|— |ditamap|Chaîne|Oui|Chemin absolu du fichier de mappage DITA dans AEM référentiel.| |baseline|String|No|Titre de la ligne de base utilisée pour récupérer le contenu versionné.
Remarque : La valeur est sensible à la casse. |

Valeurs de réponse: fichier .zip dont le contenu est écrit dans le flux de sortie de la réponse.

Lancement de l’exportation pour le mappage DITA avec les dépendances

Méthode de POST qui initie une exportation pour un mappage DITA avec toutes ses dépendances telles que les rubriques référencées, les sous-cartes, les images et les DTD utilisées dans la carte et les rubriques. L’état peut ensuite être interrogé et l’URL de téléchargement peut être récupérée une fois l’opération terminée.

URL de la requête: http://<aem-guides-server>: <port-number>/bin/dxml/async-export

Paramètres: |Nom|Type|Obligatoire|Description| |—|—|—|— |ditamap|Chaîne|Oui|Chemin absolu du fichier de mappage DITA dans AEM référentiel.| |baseline|String|No|Titre de la ligne de base utilisée pour récupérer le contenu versionné.
Remarque : La valeur est sensible à la casse.| |flatFS|Booléen|Non|(Facultatif) Si la valeur est définie sur true, une structure plate des fichiers est renvoyée dans le fichier ZIP. Par exemple, si votre mappage DITA fait référence au contenu de plusieurs dossiers, tous les fichiers référencés sont extraits dans un seul dossier. S’il existe des fichiers portant le même nom, ces fichiers sont renommés en ajoutant un suffixe numérique. Toutes les références (dans le mappage DITA et les rubriques) sont gérées automatiquement, car elles sont mises à jour en fonction du nouvel emplacement des fichiers dans la structure de dossiers plate. S’il est défini sur false, la structure de dossiers est conservée telle quelle dans le fichier ZIP. Si le mappage DITA fait référence à des fichiers provenant de plusieurs emplacements, tous ces emplacements sont également créés dans le fichier ZIP. Lorsque vous restaurez le fichier ZIP, la structure exacte des dossiers est créée à l’emplacement de destination.
La valeur par défaut de ce paramètre est false.|

Valeurs de réponse: |Elément|Description| |—|—| |status|L’état de retour de l’opération effectuée. Les options possibles sont : DÉMARRÉ, ÉCHEC, INPROGRESSION, SUCCÈS, MANQUANT, SUPPRIMÉ| |jobId|L’identifiant unique de la tâche. Peut être utilisé ultérieurement pour interroger l’état.| |errorMessage|Message d’erreur de la tâche en cas d’échec (si l’état est EN ÉCHEC, MANQUANT ou SUPPRIMÉ).| |filePath|Le chemin d’accès au fichier ZIP. Il est présent uniquement lorsque la tâche est terminée et que l’état est SUCCEED. Vous pouvez l’utiliser pour télécharger le fichier ZIP.|

Statut du mappage DITA d’export de requête

Méthode de GET qui récupère l’état de l’exportation pour un mappage DITA avec tous ses dépendances. Il peut être interrogé à un intervalle si l’état est DÉMARRÉ ou INPROGRESSÉ jusqu’à ce qu’il soit terminé (avec succès ou avec une erreur).

URL de la requête: http://<aem-guides-server>: <port-number>/bin/dxml/async-export

Paramètres
|Nom|Type|Obligatoire|Description| |—|—|—|— |jobId|Chaîne|Oui|L’ID de tâche récupéré lors du lancement de la tâche d’exportation.|

Valeurs de réponse: |Elément|Description| |—|—| |status|L’état de la tâche d’exportation. Les options possibles sont : DÉMARRÉ, ÉCHEC, INPROGRESSION, SUCCÈS, MANQUANT, SUPPRIMÉ| |jobId|L’identifiant unique de la tâche. Peut être utilisé ultérieurement pour interroger l’état.| |errorMessage|Message d’erreur de la tâche en cas d’échec (si l’état est EN ÉCHEC, MANQUANT ou SUPPRIMÉ).| |filePath|Le chemin d’accès au fichier ZIP. Il est présent uniquement lorsque la tâche est terminée et que l’état est SUCCEED. Vous pouvez l’utiliser pour télécharger le fichier ZIP.|