API REST per la gestione dell’output

Ultimo aggiornamento: 12 settembre 2024

Creato per:

  • Esperto
  • Sviluppatore

Le seguenti API REST sono disponibili per la gestione dell’output in AEM Guides.

Ottenere tutti i predefiniti di output per una mappa DITA

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:

NomeTipoObbligatorioDescrizione
:operationStringaSìNome dell'operazione chiamata. Il valore di questo parametro è getalloutputs.
Nota: il valore non distingue tra maiuscole e minuscole.
sourcePathStringaSìPercorso assoluto del file mappa DITA.

Valori risposta:
Restituisce una matrice di oggetti Predefinito di output JSON, ognuno dei quali contiene i seguenti elementi:

ElementoDescrizione
outputNameNome del predefinito di output. I nomi di output sono univoci nell'ambito della mappa DITA in cui sono definiti.
outputTypeTipo di output generato utilizzando questo predefinito, ad esempio Sito AEM, PDF, EPUB o altro. Opzioni disponibili:
- AEMSITE
- PDF
- HTML5
- EPUB
- PERSONALIZZATO
outputTitleNome descrittivo per le impostazioni del predefinito di output. Viene utilizzato per definire il valore della proprietà Nome impostazione per il predefinito di output.
ditaValPathListArray di percorsi di file DITAVAL da utilizzare per generare l'output desiderato.
targetPathPercorso in cui viene pubblicato o memorizzato l’output.
siteName(Per output sito AEM) Nome del sito AEM.
templatePath(Per output sito AEM) Percorso del nodo del modello da utilizzare per generare l'output desiderato.
searchScopeSpecificare l'ambito dell'operazione di ricerca. Il valore di questo parametro deve essere impostato su local.
generateTOC(Per output sito AEM) Specificare se viene generato un sommario (true) o meno (false).
generateBreadcrumbs(Per output sito AEM) Specificare se le breadcrumb vengono generate (true) o meno (false).
overwriteStrategy(Per l'output del sito AEM) Specificare se i file di destinazione sono sovrascritti (true) o meno (false).
pdfGeneratorSpecifica il motore di generazione PDF da utilizzare. I valori possibili sono:
- DITAOT
- FMPS
NOTE
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:

NomeTipoObbligatorioDescrizione
:operationStringaSìNome dell'operazione chiamata. Il valore di questo parametro è createoutput.
Nota: il valore non distingue tra maiuscole e minuscole.
sourcePathStringaSìPercorso assoluto del file mappa DITA.
outputTitleStringaSìNome descrittivo per le impostazioni del predefinito di output. Utilizzato per definire il valore della proprietà Nome impostazione per il predefinito di output.
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.
outputTypeStringaSìTipo di output generato utilizzando questo predefinito, ad esempio Sito AEM, PDF, EPUB o altro. Opzioni disponibili:
- AEMSITE
- PDF
- HTML5
- EPUB
- PERSONALIZZATO

Valori risposta:

ElementoDescrizione
outputNameNome univoco per il predefinito di output appena creato. Questo nome deriva dal valore del parametro 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:

NomeTipoObbligatorioDescrizione
:operationStringaSìNome dell'operazione chiamata. Il valore di questo parametro è saveoutput.
Nota: il valore non distingue tra maiuscole e minuscole.
sourcePathStringaSìPercorso assoluto del file mappa DITA.
outputObjStringaSìOggetto JSON contenente le proprietà del predefinito di output che viene aggiornato. La proprietà 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:

NomeTipoObbligatorioDescrizione
:operationStringaSìNome dell'operazione chiamata. Il valore di questo parametro è getoutput.
Nota: il valore non distingue tra maiuscole e minuscole.
sourcePathStringaSìPercorso assoluto del file mappa DITA.
outputNameStringaSìNome del predefinito di output per il quale devono essere recuperati i dettagli.

Valori risposta:

ElementoDescrizione
outputNameNome del predefinito di output. I nomi di output sono univoci nell'ambito della mappa DITA in cui sono definiti.
outputTypeTipo di output generato utilizzando questo predefinito, ad esempio Sito AEM, PDF, EPUB o altro. Opzioni disponibili:
- AEMSITE
- PDF
- HTML5
- EPUB
- PERSONALIZZA
outputTitleNome descrittivo per le impostazioni del predefinito di output. Viene utilizzato per definire il valore della proprietà Nome impostazione per il predefinito di output.
ditaValPathListArray di percorsi di file DITAVAL da utilizzare per generare l'output desiderato.
targetPathPercorso in cui viene pubblicato o memorizzato l’output.
siteName(Per output sito AEM) Nome del sito AEM.
siteTitle(Per output sito AEM) Titolo del sito AEM.
templatePath(Per output sito AEM) Percorso del nodo modello da utilizzare per generare l’output desiderato.
searchScopeSpecificare l'ambito dell'operazione di ricerca. Il valore di questo parametro deve essere impostato su local.
generateTOC(Per output sito AEM) Specificare se viene generato un sommario (true) o meno (false).
generateBreadcrumbs(Per l’output del sito AEM) Specifica se le breadcrumb vengono generate (true) o meno (false).
overwriteFiles(Per l'output del sito AEM) Specificare se i file di destinazione devono essere sovrascritti (true) o meno (false).
pdfGeneratorSpecifica il motore di generazione PDF da utilizzare. I valori possibili sono:
- DITAOT
- FMPS
NOTE
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:

NomeTipoObbligatorioDescrizione
operationStringaSìNome dell'operazione chiamata. Il valore di questo parametro è GENERATEOUTPUT.
Nota: il valore fa distinzione tra maiuscole e minuscole.
sourceStringaSìPercorso assoluto del file mappa DITA.
outputNameStringaSìNome del predefinito di output(s) da utilizzare per generare l'output. È possibile specificare più predefiniti di output utilizzando un delimitatore pipe ("|"), ad esempio `aemsite

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:

NomeTipoObbligatorioDescrizione
operationStringaSìNome dell'operazione chiamata. Il valore di questo parametro è INCREMENTALPUBLISH.
Nota: il valore fa distinzione tra maiuscole e minuscole.
contentPathJSONSìPercorso assoluto del file mappa DITA e dei file argomento insieme al nome dei predefiniti di output. Utilizza l’esempio seguente come blocco predefinito:
{
   {
   "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:

NomeTipoObbligatorioDescrizione
:operationStringaSìNome dell'operazione chiamata. Il valore di questo parametro è deleteoutput.
Nota: il valore non distingue tra maiuscole e minuscole.
sourcePathStringaSìPercorso assoluto del file mappa DITA.
outputNameStringaSìNome del predefinito di output da eliminare.

Valori risposta:
Restituisce una risposta HTTP 200 (Riuscito).

Pagina precedenteIntroduzione
Pagina successivaAPI REST per lavorare con le mappe DITA

Experience Manager