Documentation AEM Guides Documentation d’AEM Guides

API REST pour la gestion de sortie id175UB30E05Z

Last update: Thu Sep 12 2024 00:00:00 GMT+0000 (Coordinated Universal Time)

Rubriques :
Gestion des sorties API REST

Créé pour :

Expérimenté
Développeur

Les API REST suivantes sont disponibles pour gérer la sortie dans AEM Guides.

Obtention de tous les paramètres prédéfinis de sortie pour un mappage DITA get-output-presets-dita-map

Méthode de POST qui récupère tous les paramètres prédéfinis de sortie configurés pour un mappage DITA.

Demander l’URL :
http://<aem-guides-server> : <port-number>/bin/publishlistener

Paramètres :

Nom

Type

Requis

Description

:operation

Chaîne

Oui

Nom de l’opération en cours d’appel. La valeur de ce paramètre est getalloutputs.
Remarque : La valeur n’est pas sensible à la casse.

sourcePath

Chaîne

Oui

Chemin d’accès absolu au fichier de mappage DITA.

Valeurs de réponse :
Renvoie un tableau d’objets JSON Output Preset, chaque objet contenant les éléments suivants :

Elément

Description

outputName

Nom du paramètre prédéfini de sortie. Les noms de sortie sont uniques dans la portée du mappage DITA dans lequel ils sont définis.

outputType

Type de sortie générée à l’aide de ce paramètre prédéfini, par exemple AEM Site, PDF, EPUB ou autre. Les options disponibles sont :
- AEMSITE
- PDF
- HTML5
- EPUB
- PERSONNALISÉ

outputTitle

Nom explicite des paramètres prédéfinis de sortie. Il est utilisé pour définir la valeur de la propriété Setting Name pour le paramètre prédéfini de sortie.

ditaValPathList

Tableau des chemins d’accès aux fichiers DITAVAL à utiliser pour générer la sortie souhaitée.

targetPath

Chemin où la sortie est publiée ou stockée.

siteName

(Pour AEM sortie du site) Nom du site AEM.

templatePath

(Pour AEM sortie du site) Chemin du noeud de modèle à utiliser pour générer la sortie souhaitée.

searchScope

Spécifiez la portée de l’opération de recherche. La valeur de ce paramètre doit être définie sur local.

generateTOC

(Pour AEM sortie du site) Indiquez si une table des matières est générée (true) ou non (false).

generateBreadcrumbs

(Pour AEM sortie du site) Indiquez si les chemins de navigation sont générés (true) ou non (false).

overwriteStrategy

(Pour AEM sortie du site) Indiquez si les fichiers à la destination sont remplacés (true) ou non (false).

pdfGenerator

Spécifiez le moteur de génération de PDF à utiliser. Les valeurs possibles sont :
- DITAOT
- FMPS

NOTE

L’élément DitaValPath n’est plus pris en charge.

Créer un paramètre prédéfini de sortie

Méthode de POST qui crée un nouveau paramètre prédéfini de sortie pour un mappage DITA.

Demander l’URL :
http://<aem-guides-server> : <port-number>/bin/publishlistener

Paramètres :

Nom

Type

Requis

Description

:operation

Chaîne

Oui

Nom de l’opération en cours d’appel. La valeur de ce paramètre est createoutput.
Remarque : La valeur n’est pas sensible à la casse.

sourcePath

Chaîne

Oui

Chemin d’accès absolu au fichier de mappage DITA.

outputTitle

Chaîne

Oui

Nom explicite des paramètres prédéfinis de sortie. Il est utilisé pour définir la valeur de la propriété Setting Name pour le paramètre prédéfini de sortie.
Remarque : Lorsqu’un nouveau paramètre prédéfini de sortie est créé, le système principal génère un nom unique pour le paramètre prédéfini de sortie à partir du titre donné.

outputType

Chaîne

Oui

Type de sortie générée à l’aide de ce paramètre prédéfini, par exemple AEM Site, PDF, EPUB ou autre. Les options disponibles sont :
- AEMSITE
- PDF
- HTML5
- EPUB
- PERSONNALISÉ

Valeurs de réponse :

Elément

Description

outputName

Nom unique du paramètre prédéfini de sortie nouvellement créé. Ce nom est dérivé de la valeur du paramètre outputTitle .

Enregistrer le paramètre prédéfini de sortie

Méthode de POST qui enregistre les modifications effectuées dans un paramètre prédéfini de sortie.

Demander l’URL :
http://<aem-guides-server> : <port-number>/bin/publishlistener

Paramètres :

Nom

Type

Requis

Description

:operation

Chaîne

Oui

Nom de l’opération en cours d’appel. La valeur de ce paramètre est saveoutput.
Remarque : La valeur n’est pas sensible à la casse.

sourcePath

Chaîne

Oui

Chemin d’accès absolu au fichier de mappage DITA.

outputObj

Chaîne

Oui

Objet JSON contenant les propriétés du paramètre prédéfini de sortie mis à jour. La propriété outputObj.outputName contient le nom du paramètre prédéfini de sortie à mettre à jour. Pour le format de l’objet JSON, consultez la table Valeurs de réponse dans Obtenir tous les paramètres prédéfinis de sortie pour une carte DITA.

Valeurs de réponse :
Renvoie une réponse HTTP 200 (Succès).

Obtenir un paramètre prédéfini de sortie spécifique

Méthode de POST qui récupère un paramètre prédéfini de sortie existant.

Demander l’URL :
http://<aem-guides-server> : <port-number>/bin/publishlistener

Paramètres :

Nom

Type

Requis

Description

:operation

Chaîne

Oui

Nom de l’opération en cours d’appel. La valeur de ce paramètre est getoutput.
Remarque : La valeur n’est pas sensible à la casse.

sourcePath

Chaîne

Oui

Chemin d’accès absolu au fichier de mappage DITA.

outputName

Chaîne

Oui

Nom du paramètre prédéfini de sortie pour lequel les détails doivent être récupérés.

Valeurs de réponse :

Elément

Description

outputName

Nom du paramètre prédéfini de sortie. Les noms de sortie sont uniques dans la portée du mappage DITA dans lequel ils sont définis.

outputType

Type de sortie générée à l’aide de ce paramètre prédéfini, par exemple AEM Site, PDF, EPUB ou autre. Les options disponibles sont :
- AEMSITE
- PDF
- HTML5
- EPUB
- PERSONNALISÉ

outputTitle

Nom explicite des paramètres prédéfinis de sortie. Il est utilisé pour définir la valeur de la propriété Setting Name pour le paramètre prédéfini de sortie.

ditaValPathList

Tableau des chemins d’accès aux fichiers DITAVAL à utiliser pour générer la sortie souhaitée.

targetPath

Chemin où la sortie est publiée ou stockée.

siteName

(Pour AEM sortie du site) Nom du site AEM.

siteTitle

(Pour AEM sortie du site) Titre du site AEM.

templatePath

(Pour AEM sortie Site) Chemin du noeud de modèle à utiliser pour générer la sortie souhaitée.

searchScope

Spécifiez la portée de l’opération de recherche. La valeur de ce paramètre doit être définie sur local.

generateTOC

(Pour AEM sortie du site) Indiquez si une table des matières est générée (true) ou non (false).

generateBreadcrumbs

(Pour AEM sortie du site) Indiquez si les chemins de navigation sont générés (true) ou non (false).

overwriteFiles

(Pour AEM sortie du site) Indiquez si les fichiers de la destination sont écrasés (true) ou non (false).

pdfGenerator

Spécifiez le moteur de génération de PDF à utiliser. Les valeurs possibles sont :
- DITAOT
- FMPS

NOTE

L’élément DitaValPath n’est plus pris en charge.

Générer la sortie

Méthode de GET qui génère une sortie à l’aide d’un ou de plusieurs paramètres prédéfinis de sortie.

Demander l’URL :
http://<aem-guides-server> : <port-number>/bin/publishlistener

Paramètres :

Nom

Type

Requis

Description

operation

Chaîne

Oui

Nom de l’opération en cours d’appel. La valeur de ce paramètre est GENERATEOUTPUT.
Remarque : La valeur est sensible à la casse.

source

Chaîne

Oui

Chemin d’accès absolu au fichier de mappage DITA.

outputName

Chaîne

Oui

Nom du paramètre prédéfini de sortie(s) à utiliser pour générer la sortie. Plusieurs paramètres prédéfinis de sortie peuvent être spécifiés à l’aide d’un délimiteur barre verticale ("|"), par exemple `aemsite

Valeurs de réponse :
Renvoie une réponse HTTP 200 (Succès).

Générer une sortie incrémentielle

Méthode de GET qui génère une sortie incrémentielle pour un site AEM à l’aide d’un ou de plusieurs paramètres prédéfinis de sortie.

Demander l’URL :
http://<aem-guides-server> : <port-number>/bin/publishlistener

Paramètres :

Nom

Type

Requis

Description

operation

Chaîne

Oui

Nom de l’opération en cours d’appel. La valeur de ce paramètre est INCREMENTALPUBLISH.
Remarque : La valeur est sensible à la casse.

contentPath

JSON

Oui

Chemin d’accès absolu au fichier de mappage DITA et aux fichiers de rubrique avec le nom des paramètres prédéfinis de sortie. Utilisez l’exemple suivant comme bloc de création :

{
   {
   "ditamap":
      "/content/dam/sample/sample.ditamap",
   "topics": [
      "/content/dam/sample/topic1.xml",
      "/content/dam/sample/topic2.xml"
         ],
   "fullMaps": [
      "/content/dam/sample/submap.ditamap"
      ],
   "maps": [
      "/content/dam/sample/keyspace.ditamap"
      ],
   "outputs": [
      "aemsite"
      ]
   }
}

L’attribut ditamap utilise le chemin d’accès absolu de la carte DITA utilisée pour générer la sortie.
L’attribut topics utilise un tableau de rubriques qui sont mises à jour et qui doivent être republiées.
L’attribut fullMaps contient le chemin d’accès aux fichiers de mappage (comme les submaps tronqués) qui sont nécessaires avec leurs rubriques pour la génération de sortie incrémentielle.
L’attribut maps contient le chemin d’accès aux fichiers de mappage (pour résoudre les références d’espace-clé) extraits sur le disque sans rubriques.
L’attribut outputs utilise un tableau de noms de paramètres prédéfinis de sortie utilisés pour générer la sortie.

Valeurs de réponse :
Renvoie une réponse HTTP 200 (Succès).

Supprimer le paramètre prédéfini de sortie

Méthode de POST qui supprime un paramètre prédéfini de sortie.

Demander l’URL :
http://<aem-guides-server> : <port-number>/bin/publishlistener

Paramètres :

Nom

Type

Requis

Description

:operation

Chaîne

Oui

Nom de l’opération en cours d’appel. La valeur de ce paramètre est deleteoutput.
Remarque : La valeur n’est pas sensible à la casse.

sourcePath

Chaîne

Oui

Chemin d’accès absolu au fichier de mappage DITA.

outputName

Chaîne

Oui

Nom du paramètre prédéfini de sortie à supprimer.

Valeurs de réponse :
Renvoie une réponse HTTP 200 (Succès).

recommendation-more-help

11125c99-e1a1-4369-b5d7-fb3098b9b178