API REST per la gestione dell’output id175UB30E05Z
Le seguenti API REST sono disponibili per la gestione dell’output in AEM Guides.
Ottenere tutti i predefiniti di output per una mappa DITA get-output-presets-dita-map
Metodo POST che recupera tutti i predefiniti di output configurati per una mappa DITA.
URL richiesta:
http://<server-guide-aem>: <numero-porta>/bin/publishlistener
Parametri:
:operation
getalloutputs
.Nota: il valore non distingue tra maiuscole e minuscole.
sourcePath
Valori risposta:
Restituisce una matrice di oggetti Predefinito di output JSON, ognuno dei quali contiene i seguenti elementi:
outputName
outputType
- AEMSITE
- HTML5
- EPUB
- PERSONALIZZATO
outputTitle
ditaValPathList
targetPath
siteName
templatePath
searchScope
local
.generateTOC
generateBreadcrumbs
overwriteStrategy
pdfGenerator
- DITAOT
- FMPS
DitaValPath
elemento non più supportato.Crea predefinito di output
Metodo POST che crea un nuovo predefinito di output per una mappa DITA.
URL richiesta:
http://<server-guide-aem>: <numero-porta>/bin/publishlistener
Parametri:
:operation
createoutput
.Nota: il valore non distingue tra maiuscole e minuscole.
sourcePath
outputTitle
Nota: quando viene creato un nuovo predefinito di output, il sistema back-end utilizza un nome univoco per il predefinito di output dal titolo specificato.
outputType
- AEMSITE
- HTML5
- EPUB
- PERSONALIZZATO
Valori risposta:
outputName
outputTitle
.Salva predefinito di output
Metodo POST che salva le modifiche apportate in un predefinito di output.
URL richiesta:
http://<server-guide-aem>: <numero-porta>/bin/publishlistener
Parametri:
:operation
saveoutput
.Nota: il valore non distingue tra maiuscole e minuscole.
sourcePath
outputObj
outputObj.outputName
contiene il nome del predefinito di output da aggiornare. Per il formato dell'oggetto JSON, vedere la tabella Valori di risposta in Ottenere tutti i predefiniti di output per una mappa DITA.Valori risposta:
Restituisce una risposta HTTP 200 (Riuscito).
Ottieni un predefinito di output specifico
Metodo POST che recupera un predefinito di output esistente.
URL richiesta:
http://<server-guide-aem>: <numero-porta>/bin/publishlistener
Parametri:
:operation
getoutput
.Nota: il valore non distingue tra maiuscole e minuscole.
sourcePath
outputName
Valori risposta:
outputName
outputType
- AEMSITE
- HTML5
- EPUB
- PERSONALIZZA
outputTitle
ditaValPathList
targetPath
siteName
siteTitle
templatePath
searchScope
local
.generateTOC
generateBreadcrumbs
overwriteFiles
pdfGenerator
- DITAOT
- FMPS
DitaValPath
elemento non più supportato.Genera output
Metodo di GET che genera output utilizzando uno o più predefiniti di output.
URL richiesta:
http://<server-guide-aem>: <numero-porta>/bin/publishlistener
Parametri:
operation
GENERATEOUTPUT
.Nota: il valore fa distinzione tra maiuscole e minuscole.
source
outputName
Valori risposta:
Restituisce una risposta HTTP 200 (Riuscito).
Genera output incrementale
Metodo di GET che genera un output incrementale per un sito AEM utilizzando uno o più predefiniti di output.
URL richiesta:
http://<server-guide-aem>: <numero-porta>/bin/publishlistener
Parametri:
operation
INCREMENTALPUBLISH
.Nota: il valore fa distinzione tra maiuscole e minuscole.
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"
]
}
}
- L'attributo
ditamap
utilizza il percorso assoluto della mappa DITA utilizzata per generare l'output. - L'attributo
topics
accetta un array di argomenti che vengono aggiornati e devono essere ripubblicati. - L'attributo
fullMaps
contiene il percorso dei file di mappa (come submaps a blocchi) necessari insieme ai relativi argomenti per la generazione dell'output incrementale. - L'attributo
maps
contiene il percorso dei file di mappa (per la risoluzione dei riferimenti dello spazio chiave) estratti sul disco senza argomenti. - L'attributo
outputs
accetta una matrice di nomi di predefiniti di output utilizzati per generare l'output.
Valori risposta:
Restituisce una risposta HTTP 200 (Riuscito).
Elimina predefinito di output
Metodo POST che elimina un predefinito di output.
URL richiesta:
http://<server-guide-aem>: <numero-porta>/bin/publishlistener
Parametri:
:operation
deleteoutput
.Nota: il valore non distingue tra maiuscole e minuscole.
sourcePath
outputName
Valori risposta:
Restituisce una risposta HTTP 200 (Riuscito).