API REST per lavorare con le mappe DITA
Ultimo aggiornamento: 12 settembre 2024
- Argomenti:
- Mappa DITA API REST
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 | Stato di ritorno per l'operazione eseguita. Le opzioni possibili sono: STARTED, FAILED, INPROGRESS, SUCCESSED, MISSING, DELETED |
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 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ì | ID del processo recuperato all’avvio del processo di esportazione. |
Valori risposta:
| Elemento | Descrizione |
|---|---|
status | Stato del processo di esportazione. Le opzioni possibili sono: STARTED, FAILED, INPROGRESS, SUCCESSED, MISSING, DELETED |
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 del file ZIP. È presente solo quando il processo è completato e lo stato è RIUSCITO. Può essere utilizzato per scaricare il file ZIP. |
Pagina precedenteAPI REST per la gestione dell’output
Pagina successivaAPI REST per registrare un connettore di origine dati
Experience Manager
- Panoramica di AEM Guides
- Dichiarazione di non responsabilità
- Informazioni sulla versione
- Roadmap delle versioni di AEM Guides
- Note sulla versione
- Cloud Services
- Istruzioni di implementazione
- Versioni del 2025
- Versioni del 2024
- Versioni del 2023
- Versioni del 2022
- On-prem/Managed Services
- Cloud Services
- Guida utente (nuova interfaccia utente)
- Introduzione
- Home page
- Contenuto autore
- Panoramica sull’authoring
- Modi per creare contenuti con AEM Guides
- Editor
- Introduzione all’editor
- Avviare l’editor
- Modifica argomenti nell’editor
- Creazione argomento e anteprima
- Conoscere le funzioni dell’editor
- Funzioni aggiuntive nell’editor
- Scelte rapide da tastiera nell’editor
- Visualizzazioni dell’editor
- Supporto per i file Schematron
- Creare documenti Markdown dall’Editor
- Aggiungere citazioni al contenuto
- Utilizza i dati delle tue origini dati
- Stato documento
- Usa etichette
- Editor mappa
- editor DITAVAL
- Strumenti desktop per la creazione del contenuto
- Rivedi contenuto
- Introduzione alla revisione
- Creare un progetto DITA
- Invia argomenti per la revisione
- Riassegna attività di revisione tramite notifica
- Rivedi argomenti
- Commenti sulla revisione degli indirizzi
- Gestire le attività di revisione mediante il dashboard Revisione
- Visualizzare un’attività di revisione completata
- Collaborazione tramite Adobe Workfront
- Metadati e assegnazione tag
- Gestione mappe e pubblicazione di
- Panoramica della console delle mappe
- Apri file nella console Mappa
- Rapporti
- Traduzione del contenuto
- Generazione output
- Nozioni di base sulla generazione di output
- Predefiniti di output in AEM Guides
- Modificare, duplicare o eliminare un predefinito di output
- Condiziona contenuto
- Usa previsione
- Gestire i predefiniti di output per Profilo globale e Cartella
- Utilizzare le variabili per impostare le opzioni Percorso di destinazione, Nome sito o Nome file
- Trasmettere i metadati all’output utilizzando DITA-OT
- Genera output
- Usa raccolta mappe per la generazione dell’output
- Gestisci processo di generazione output
- Gestire le attività di pubblicazione tramite il dashboard di pubblicazione
- Risoluzione dei problemi di base
- Attivazione in blocco del contenuto
- Generazione output di documenti FrameMaker
- Assistente IA in AEM Guides
- Informazioni sugli utenti di Adobe Generative AI
- Panoramica dell’Assistente AI
- Guida intelligente basata sull’intelligenza artificiale per cercare contenuti
- Creazione guidata Assistente AI per l’authoring intelligente dei documenti
- Suggerimenti avanzati basati sull’intelligenza artificiale per l’authoring dei contenuti
- Domande frequenti
- Appendice
- Guida utente (precedente interfaccia utente)
- Installazione e configurazione
- On-premise
- Nozioni di base on-premise
- Scarica, installa e aggiorna
- Panoramica sul download e sull’installazione
- Requisiti tecnici
- Installare Adobe Experience Manager
- Scarica e installa AEM Guides per la prima volta
- Configurare Dispatcher
- Verificare l’installazione di AEM Guides
- Aggiornare AEM Guides
- Disinstallare AEM Guides
- Consigli per l’ottimizzazione delle prestazioni
- Utilizzare i gruppi di utenti e la sicurezza
- Migrazione dei contenuti
- Utilizzare DITA-OT personalizzato e la specializzazione
- Configurare la post-elaborazione per una cartella
- Configura nomi file
- Configurare nomi di file automatici basati su UUID
- Configura Regx per caratteri validi per i nomi di file
- Configurare nomi di file validi per l’output del sito AEM
- Utilizzare i modelli di argomento e mappa
- Utilizzare gli stati del documento
- Utilizzare le configurazioni dell’editor Web
- Personalizza editor web
- Personalizza barra degli strumenti
- Configura il valore predefinito per la vista Tag
- Configurare il titolo per le icone Archivia ed Estrai
- Configurare la visualizzazione dei collegamenti basati su UUID
- Aprire un argomento DITA o mappare i file nella stessa scheda
- Configurare un pannello personalizzato nel pannello a sinistra
- Configurare il salvataggio automatico dei file nell’editor web
- Configurare i filtri per la finestra di dialogo Sfoglia file
- Configura richiesta di salvataggio come nuova versione alla chiusura
- Configurare la richiesta di archiviazione di un file alla chiusura
- Configurare i caratteri speciali consentiti
- Genera automaticamente ID elemento
- Personalizzare il dizionario predefinito di AEM
- Configurare i filtri di testo
- Configurare il numero di LimitReads per una query
- Installare pacchetti per la pubblicazione basata su articoli
- Configurare un connettore origine dati dall’interfaccia utente
- Imposta l’Editor mappe avanzato come predefinito
- Includi attributo @navtitle per impostazione predefinita
- Configurare l’opzione da modificare in Ossigeno
- Configurare caratteri speciali aggiuntivi
- Utilizzare i profili globali e a livello di cartella
- Configura versioni
- Utilizzare gli editor XML basati su desktop
- Utilizzare le impostazioni di generazione output
- Configurare le impostazioni di generazione dell’output
- Scarica e installa i modelli di AEM Sites
- Sovrapporre i tag HTML nell’output di AEM Sites
- Pubblicazione PDF nativa
- Modello PDF
- Componenti di un modello PDF
- Progettare un layout di pagina
- Variabili nell’output PDF
- Supporto per le variabili di lingua
- Aggiungere un codice a barre all’output di PDF
- Stili di contenuto comuni
- Utilizzare gli stili di contenuto comuni
- Utilizzare gli stili delle barre di modifica personalizzati
- Applicare uno stile personalizzato alle voci del sommario e al contenuto dell’argomento
- Aggiungere un segnalibro personalizzato nell’output di PDF
- Utilizzare JavaScript per lavorare con contenuto o stile
- Applicare gli stili alle note a piè di pagina
- Configurare i flag JVM per la pubblicazione nativa di PDF
- Configurare e personalizzare i flussi di lavoro
- Utilizzare le configurazioni di traduzione
- Utilizzare la ricerca di AEM Assets
- Appendice
- Cloud Services
- Informazioni su questa guida
- Distribuire e configurare AEM Guides as Cloud Service
- Utilizzare i gruppi di utenti e la sicurezza
- Migrazione contenuto
- Utilizzare DITA-OT personalizzato e la specializzazione
- Configurare i nomi di file basati su UUID e non su UUID
- Utilizzare i modelli di argomento e mappa
- Utilizzare gli stati del documento
- Utilizzare le configurazioni dell’editor Web
- Personalizza editor web
- Personalizza barra degli strumenti
- Configurare i suggerimenti avanzati basati sull’intelligenza artificiale per la creazione
- Configurare la Guida avanzata basata sull’intelligenza artificiale per cercare contenuti
- Configura il valore predefinito per la vista Tag
- Configurare la visualizzazione dei collegamenti basati su UUID
- Configura visualizzazione tabelle incollate
- Aprire un argomento DITA o mappare i file nella stessa scheda
- Configurare un pannello personalizzato nel pannello a sinistra
- Configurare il salvataggio automatico dei file nell’editor web
- Configura richiesta di salvataggio come nuova versione alla chiusura
- Configurare la richiesta di archiviazione di un file alla chiusura
- Configurare i caratteri speciali consentiti
- Genera automaticamente ID elemento
- Personalizzare il dizionario predefinito di AEM
- Configurare i filtri di testo
- Configurare i filtri per la finestra di dialogo Sfoglia file
- Installare pacchetti per la pubblicazione basata su articoli
- Configurare la generazione di PDF con argomento singolo
- Configurare la funzione di traduzione nell’editor web
- Configurare un connettore di origine dati
- Configurare un connettore origine dati dall’interfaccia utente
- Imposta l’Editor mappe avanzato come predefinito
- Includi attributo @navtitle per impostazione predefinita
- Utilizzare i profili globali e a livello di cartella
- Configura versioni
- Utilizzare gli editor XML basati su desktop
- Configura Workfront
- Utilizzare le impostazioni di generazione output
- Configurare le impostazioni di generazione dell’output
- Scarica e installa i modelli di AEM Sites
- Pubblicazione PDF nativa
- Configura processo nodo per pubblicazione PDF nativa
- Creare una mappatura tra un argomento e un frammento di contenuto
- Creare una mappatura tra un argomento e un frammento di esperienza
- Utilizzare flussi di lavoro personalizzati
- Utilizzare le configurazioni di traduzione
- Utilizzare la ricerca di AEM Assets
- Appendice
- On-premise
- Riferimento API
- Introduzione
- API REST per la gestione dell’output
- API REST per lavorare con le mappe DITA
- API REST per registrare un connettore di origine dati
- API REST per funzionare con gli attributi condizionali
- API REST per il flusso di lavoro di conversione
- API REST per la creazione e l’attivazione dei pacchetti
- API basata su Java per lavorare con la generazione di output
- API basate su Java per l’utilizzo delle mappe DITA
- API basate su Java per il flusso di lavoro di conversione
- API basate su Java per lavorare con le linee di base e le etichette
- API basata su Java per lavorare con i profili di cartelle
- API basata su Java per la creazione e l’attivazione di pacchetti
- Gestore di eventi di post-elaborazione
- Gestore eventi di completamento attivazione in blocco
- Gestore di eventi del processo di conversione
- Knowledge Base
- Sessione esperti
- Panoramica della sessione con esperti
- Tradurre il contenuto
- Gestire i contenuti tramite le linee di base
- Creare contenuti basati sul web
- Nozioni di base sulla pubblicazione nativa di PDF
- Rapporti in AEM Guides
- Configurazione di contenuti e modelli
- Pubblicazione PDF nativa per l’apprendimento - parte 1
- Apprendimento di PDF publishing nativo - Laboratorio pratico - BYOS
- Framework di estensione di AEM Guides
- Integrazione origine dati esterna
- Tradurre il contenuto nelle guide - parte 2
- Definire, gestire e utilizzare i metadati
- Varianti di output di AEM Sites
- Opzioni di implementazione e migrazione a Cloud
- Migrazione di contenuti da non-uuid a UUID
- Migrazione dei contenuti Delta
- Articoli
- Authoring
- Framework di estensione delle guide
- Origine dati esterna
- Pubblicazione
- Flussi di lavoro
- Traduzione
- Casi d’uso
- Sessione esperti