DocumentazioneAEM GuidesDocumentazione di AEM Guides

API REST per lavorare con le mappe DITA id175UB30E05Z

Last update: Thu Jul 18 2024 00:00:00 GMT+0000 (Coordinated Universal Time)

Creato per:

  • Esperto
  • Sviluppatore

La seguente API REST consente di lavorare con le mappe DITA in AEM Guides.

Scarica mappa DITA con dipendenti

Metodo di GET che scarica una mappa DITA con tutti i relativi dipendenti, ad esempio gli argomenti di riferimento, le mappe secondarie, le immagini e le DTD utilizzate nella mappa e negli argomenti.

URL richiesta:
http://<server-guide-aem>: <numero-porta>/bin/fmdita/exportditamap

Parametri:

Nome
Tipo
Obbligatorio
Descrizione
ditamap
Stringa
Sì
Percorso assoluto del file mappa DITA nell'archivio AEM.
baseline
Stringa
No
Titolo della linea di base utilizzata per recuperare il contenuto con versione.
Nota: il valore fa distinzione tra maiuscole e minuscole.

Valori risposta:
Un file .zip il cui contenuto viene scritto nel flusso di output della risposta.

Avvia esportazione per mappa DITA con dipendenti

Metodo POST che avvia un'esportazione per una mappa DITA con tutti i relativi dipendenti, ad esempio argomenti di riferimento, mappe secondarie, immagini e DTD utilizzati nella mappa e negli argomenti. Successivamente è possibile interrogare lo stato e recuperare l’URL di download al termine dell’operazione.

URL richiesta:
http://<server-guide-aem>: <numero-porta>/bin/dxml/async-export

Parametri:

Nome
Tipo
Obbligatorio
Descrizione
ditamap
Stringa
Sì
Percorso assoluto del file mappa DITA nell'archivio AEM.
baseline
Stringa
No
Titolo della linea di base utilizzata per recuperare il contenuto con versione.
Nota: il valore fa distinzione tra maiuscole e minuscole.
flatFS
Booleano
No
(Facoltativo) Se impostato su true, nel file ZIP viene restituita una struttura semplice di file. Ad esempio, se la mappa DITA fa riferimento a contenuto in più cartelle, tutti i file di riferimento vengono estratti in un'unica cartella. Nel caso vi siano file con lo stesso nome, tali file vengono rinominati aggiungendo un suffisso numerico. Tutti i riferimenti (in mappa DITA e argomenti) vengono gestiti automaticamente, in quanto vengono aggiornati in base alla nuova posizione dei file nella struttura di cartelle flat. Se impostato su false, la struttura delle cartelle viene mantenuta invariata nel file ZIP. Se la mappa DITA fa riferimento a file provenienti da più posizioni, anche tutte queste posizioni vengono create nel file ZIP. Quando si ripristina il file ZIP, viene creata la struttura di cartelle esatta nel percorso di destinazione.
Il valore predefinito per questo parametro è false.

Valori risposta:
|Elemento|Descrizione|
​----------- -------
|status|Lo stato restituito per l'operazione eseguita. Le opzioni possibili sono: AVVIATO, NON RIUSCITO, IN CORSO, RIUSCITO, MANCANTE, ELIMINATO|
|jobId|ID univoco del processo. Può essere utilizzato in seguito per eseguire una query per lo stato.|
|errorMessage|Messaggio di errore del processo in caso di errore (se lo stato è FAILED, MISSING o DELETED).|
|filePath|Percorso file del file ZIP. È presente solo quando il processo è completato e lo stato è RIUSCITO. Può essere utilizzato per scaricare il file ZIP.|

Stato mappa DITA esportazione query

Un metodo GET che recupera lo stato di esportazione di una mappa DITA con tutti i relativi dipendenti. È possibile eseguire il polling a intervalli se lo stato è STARTED o INPROGRESS fino al completamento (riuscito o con un errore).

URL richiesta:
http://<server-guide-aem>: <numero-porta>/bin/dxml/async-export

Parametri

Nome
Tipo
Obbligatorio
Descrizione
jobId
Stringa
Sì
L'ID processo recuperato all'avvio del processo di esportazione.

Valori risposta:
|Elemento|Descrizione|
​----------- -------
|status|Stato del processo di esportazione. Le opzioni possibili sono: AVVIATO, NON RIUSCITO, IN CORSO, RIUSCITO, MANCANTE, ELIMINATO|
|jobId|ID univoco del processo. Può essere utilizzato in seguito per eseguire una query per lo stato.|
|errorMessage|Messaggio di errore del processo in caso di errore (se lo stato è FAILED, MISSING o DELETED).|
|filePath|Percorso file del file ZIP. È presente solo quando il processo è completato e lo stato è RIUSCITO. Può essere utilizzato per scaricare il file ZIP.|

recommendation-more-help
11125c99-e1a1-4369-b5d7-fb3098b9b178