REST API:er för utdatahantering id175UB30E05Z
Följande REST-API:er är tillgängliga för hantering av utdata i AEM Guides.
Hämta alla förinställningar för en DITA-karta get-output-presets-dita-map
En POST-metod som hämtar alla förinställningar som konfigurerats för en DITA-karta.
Begär URL:
http://<aem-guides-server>: <portnummer>/bin/publishlistener
Parametrar:
:operation
getalloutputs
.Obs! Värdet är inte skiftlägeskänsligt.
sourcePath
Svarsvärden:
Returnerar en array med förinställda JSON-utdataobjekt, där varje objekt innehåller följande element:
outputName
outputType
- AEMSITE
- HTML5
- EPUB
- ANPASSAD
outputTitle
ditaValPathList
targetPath
siteName
templatePath
searchScope
local
.generateTOC
generateBreadcrumbs
overwriteStrategy
pdfGenerator
- DITAOT
- FMPS
DitaValPath
stöds inte längre.Skapa förinställning för utdata
En POST-metod som skapar en ny förinställning för en DITA-karta.
Begär URL:
http://<aem-guides-server>: <portnummer>/bin/publishlistener
Parametrar:
:operation
createoutput
.Obs! Värdet är inte skiftlägeskänsligt.
sourcePath
outputTitle
Obs! När en ny förinställning skapas, kör back-end-systemet ett unikt namn för utdataförinställningen från den angivna titeln.
outputType
- AEMSITE
- HTML5
- EPUB
- ANPASSAD
Svarsvärden:
outputName
outputTitle
.Spara förinställning för utdata
En POST-metod som sparar ändringar som gjorts i en förinställning.
Begär URL:
http://<aem-guides-server>: <portnummer>/bin/publishlistener
Parametrar:
:operation
saveoutput
.Obs! Värdet är inte skiftlägeskänsligt.
sourcePath
outputObj
outputObj.outputName
innehåller namnet på den förinställning som ska uppdateras. JSON-objektets format finns i tabellen Svarsvärden i Hämta alla förinställningar för en DITA-karta.Svarsvärden:
Returnerar ett HTTP 200 (Slutförd)-svar.
Hämta en specifik förinställning
En metod som hämtar en befintlig förinställning för POST.
Begär URL:
http://<aem-guides-server>: <portnummer>/bin/publishlistener
Parametrar:
:operation
getoutput
.Obs! Värdet är inte skiftlägeskänsligt.
sourcePath
outputName
Svarsvärden:
outputName
outputType
- AEMSITE
- HTML5
- EPUB
- ANPASSAD
outputTitle
ditaValPathList
targetPath
siteName
siteTitle
templatePath
searchScope
local
.generateTOC
generateBreadcrumbs
overwriteFiles
pdfGenerator
- DITAOT
- FMPS
DitaValPath
stöds inte längre.Generera utdata
En GET-metod som genererar utdata med en eller flera förinställningar.
Begär URL:
http://<aem-guides-server>: <portnummer>/bin/publishlistener
Parametrar:
operation
GENERATEOUTPUT
.Obs! Värdet är skiftlägeskänsligt.
source
outputName
Svarsvärden:
Returnerar ett HTTP 200 (Slutförd)-svar.
Generera inkrementella utdata
En GET-metod som genererar inkrementella utdata för en AEM webbplats med en eller flera utdatainställningar.
Begär URL:
http://<aem-guides-server>: <portnummer>/bin/publishlistener
Parametrar:
operation
INCREMENTALPUBLISH
.Obs! Värdet är skiftlägeskänsligt.
contentPath
{
{
"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"
]
}
}
- Attributet
ditamap
har den absoluta sökvägen för den DITA-karta som används för att generera utdata. - Attributet
topics
innehåller en matris med ämnen som har uppdaterats och måste publiceras på nytt. - Attributet
fullMaps
innehåller sökvägen till mappningsfilerna (t.ex. kapslade underpunkter) som behövs tillsammans med avsnitten för att generera inkrementella utdata. - Attributet
maps
innehåller sökvägen till mappningsfilerna (för att matcha nyckelutrymmesreferenser) som extraheras på disken utan ämnen. - Attributet
outputs
tar en array med förinställningsnamn för utdata som används för att generera utdata.
Svarsvärden:
Returnerar ett HTTP 200 (Slutförd)-svar.
Ta bort förinställning för utdata
En POST som tar bort en förinställning.
Begär URL:
http://<aem-guides-server>: <portnummer>/bin/publishlistener
Parametrar:
:operation
deleteoutput
.Obs! Värdet är inte skiftlägeskänsligt.
sourcePath
outputName
Svarsvärden:
Returnerar ett HTTP 200 (Slutförd)-svar.