REST-APIs für die Output-Verwaltung id175UB30E05Z

Die folgenden REST-APIs stehen zur Verwaltung der Ausgabe in AEM Guides zur Verfügung.

Abrufen aller Ausgabevorgaben für eine DITA-Zuordnung get-output-presets-dita-map

Eine POST -Methode, die alle für eine DITA-Zuordnung konfigurierten Ausgabevorgaben abruft.

Anforderungs-URL:
http://<aem-guides-server>: <port-number>/bin/publishlistener

Parameter:
|Name|Typ|Erforderlich|Beschreibung|
|—|—|—|—|—|
|:operation|String|Yes|Name des aufzurufenden Vorgangs. Der Wert dieses Parameters ist getalloutputs.
Hinweis: Beim Wert wird nicht zwischen Groß- und Kleinschreibung unterschieden.|
|sourcePath|String|Ja|Absoluter Pfad der DITA-Map-Datei.|

Antwortwerte:
Gibt ein Array von JSON Output Preset -Objekten zurück, von denen jedes die folgenden Elemente enthält:

Ausgabevorgabe erstellen

Eine POST -Methode, die eine neue Ausgabevorgabe für eine DITA-Zuordnung erstellt.

Anforderungs-URL:
http://<aem-guides-server>: <port-number>/bin/publishlistener

Parameter:
|Name|Typ|Erforderlich|Beschreibung|
|—|—|—|—|—|
|:operation|String|Yes|Name des aufzurufenden Vorgangs. Der Wert dieses Parameters ist createoutput.
Hinweis: Beim Wert wird nicht zwischen Groß- und Kleinschreibung unterschieden.|
|sourcePath|String|Ja|Absoluter Pfad der DITA-Map-Datei.|
|outputTitle|String|Ja|Ein beschreibender Name für die Ausgabevorgabeneinstellungen. Damit wird der Wert für die Eigenschaft "Setting Name"für die Ausgabevorgabe definiert.
Hinweis: Wenn eine neue Ausgabevorgabe erstellt wird, gibt das Backend-System einen eindeutigen Namen für die Ausgabevorgabe aus dem angegebenen Titel aus.|
|outputType|String|Ja|Ausgabetyp, der mithilfe dieser Vorgabe generiert wurde, z. B. AEM Site, PDF, EPUB oder andere. Die verfügbaren Optionen sind:
- AEMSITE
- PDF
- HTML5
- EPUB
- BENUTZERDEFINIERT|

Antwortwerte:
|Element|Beschreibung|
|—|—|
|outputName|Ein eindeutiger Name für die neu erstellte Ausgabevorgabe. Dieser Name wird aus dem Wert des Parameters outputTitle abgeleitet.|

Ausgabevorgabe speichern

Eine POST-Methode, die Änderungen speichert, die an einer Ausgabevorgabe vorgenommen wurden.

Anforderungs-URL:
http://<aem-guides-server>: <port-number>/bin/publishlistener

Parameter:
|Name|Typ|Erforderlich|Beschreibung|
|—|—|—|—|—|
|:operation|String|Yes|Name des aufzurufenden Vorgangs. Der Wert dieses Parameters ist saveoutput.
Hinweis: Beim Wert wird nicht zwischen Groß- und Kleinschreibung unterschieden.|
|sourcePath|String|Ja|Absoluter Pfad der DITA-Map-Datei.|
|outputObj|String|Ja|Ein JSON-Objekt, das Eigenschaften der zu aktualisierenden Ausgabevorgabe enthält. Die Eigenschaft outputObj.outputName enthält den Namen der zu aktualisierenden Ausgabevorgabe. Informationen zum Format des JSON-Objekts finden Sie in der Tabelle Antwortwerte in Abrufen aller Ausgabevorgaben für eine DITA-Zuordnung.|

Antwortwerte:
Gibt eine HTTP-Antwort 200 (Erfolgreich) zurück.

Abrufen einer bestimmten Ausgabevorgabe

Eine POST -Methode, die eine vorhandene Ausgabevorgabe abruft.

Anforderungs-URL:
http://<aem-guides-server>: <port-number>/bin/publishlistener

Parameter:
|Name|Typ|Erforderlich|Beschreibung|
|—|—|—|—|—|
|:operation|String|Yes|Name des aufzurufenden Vorgangs. Der Wert dieses Parameters ist getoutput.
Hinweis: Beim Wert wird nicht zwischen Groß- und Kleinschreibung unterschieden.|
|sourcePath|String|Ja|Absoluter Pfad der DITA-Map-Datei.|
|outputName|String|Ja|Name der Ausgabevorgabe, für die die Details abgerufen werden müssen.|

Antwortwerte:
|Element|Beschreibung|
|—|—|
|outputName|Name der Ausgabevorgabe. Ausgabenamen sind im Umfang der DITA-Zuordnung, in der sie definiert sind, eindeutig.|
|outputType|Ausgabetyp, der mit dieser Vorgabe generiert wurde, z. B. AEM Site, PDF, EPUB oder andere. Die verfügbaren Optionen sind:
- AEMSITE
- PDF
- HTML5
- EPUB
- BENUTZERDEFINIERTER
|
|outputTitle|Ein beschreibender Name für die Ausgabevorgabeneinstellungen. Damit wird der Wert für die Eigenschaft "Setting Name"für die Ausgabevorgabe definiert.|
|ditaValPathList|Array von DITAVAL-Dateipfaden, die zum Generieren der gewünschten Ausgabe verwendet werden sollen.|
|targetPath|Pfad, in dem die Ausgabe veröffentlicht oder gespeichert wird.|
|siteName|(Für AEM Site-Ausgabe) Name der AEM Site.|
|siteTitle|(Für AEM Site-Ausgabe) Titel der AEM Site.|
|templatePath|(Für AEM Site-Ausgabe) Pfad des Vorlagenknotens, der zum Generieren der gewünschten Ausgabe verwendet werden soll.|
|searchScope|Geben Sie den Perimeter für den Suchvorgang an. Der Wert für diesen Parameter muss auf local gesetzt werden.|
|generateTOC|(Für AEM Site-Ausgabe) Geben Sie an, ob ein Inhaltsverzeichnis generiert wird (true) oder nicht (false).|
|generateBreadcrumbs|(Für AEM Site-Ausgabe) Geben Sie an, ob die Breadcrumbs generiert werden (true) oder nicht (false).|
|overwriteFiles|(Für AEM Site-Ausgabe) Geben Sie an, ob Dateien am Ziel überschrieben werden (true) oder nicht (false).|
|pdfGenerator|Geben Sie die zu verwendende PDF-Generierungs-Engine an. Die möglichen Werte sind:
- DITAOT
- FMPS|

Ausgabe generieren

Eine GET-Methode, die die Ausgabe mithilfe einer oder mehrerer Ausgabevorgaben generiert.

Anforderungs-URL:
http://<aem-guides-server>: <port-number>/bin/publishlistener

Parameter:
|Name|Typ|Erforderlich|Beschreibung|
|—|—|—|—|—|
|operation|String|Yes|Name des aufzurufenden Vorgangs. Der Wert dieses Parameters ist GENERATEOUTPUT.
Hinweis: Beim Wert wird zwischen Groß- und Kleinschreibung unterschieden.|
|source|String|Ja|Absoluter Pfad der DITA-Map-Datei.|
|outputName|String|Ja|Name der Ausgabevorgabe(n), die zum Generieren der Ausgabe verwendet werden soll. Mehrere Ausgabevorgaben können mit einem senkrechten Strich ("|") angegeben werden, z. B. aemsite|pdfoutput.|

Antwortwerte:
Gibt eine HTTP-Antwort 200 (Erfolgreich) zurück.

Inkrementelle Ausgabe generieren

Eine GET-Methode, die mithilfe einer oder mehrerer Ausgabevorgaben eine inkrementelle Ausgabe für eine AEM Site generiert.

Anforderungs-URL:
http://<aem-guides-server>: <port-number>/bin/publishlistener

Parameter:
|Name|Typ|Erforderlich|Beschreibung|
|—|—|—|—|—|
|operation|String|Yes|Name des aufzurufenden Vorgangs. Der Wert dieses Parameters ist INCREMENTALPUBLISH.
Hinweis: Beim Wert wird zwischen Groß- und Kleinschreibung unterschieden.|
|contentPath|JSON|Ja|Absoluter Pfad der DITA-Map-Datei und Themendateien zusammen mit dem Namen der Ausgabevorgaben. Verwenden Sie das folgende Beispiel als Baustein:|

{
   {
   "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"
      ]
   }
}

Antwortwerte:
Gibt eine HTTP-Antwort 200 (Erfolgreich) zurück.

Ausgabevorgabe löschen

Eine POST-Methode zum Löschen einer Ausgabevorgabe.

Anforderungs-URL:
http://<aem-guides-server>: <port-number>/bin/publishlistener

Parameter:
|Name|Typ|Erforderlich|Beschreibung|
|—|—|—|—|—|
|:operation|String|Yes|Name des aufzurufenden Vorgangs. Der Wert dieses Parameters ist deleteoutput.
Hinweis: Beim Wert wird nicht zwischen Groß- und Kleinschreibung unterschieden.|
|sourcePath|String|Ja|Absoluter Pfad der DITA-Map-Datei.|
|outputName|String|Ja|Name der zu löschenden Ausgabevorgabe.|

Antwortwerte:
Gibt eine HTTP-Antwort 200 (Erfolgreich) zurück.