REST API för arbete med DITA-kartor id175UB30E05Z
Last update: Fri Jul 19 2024 00:00:00 GMT+0000 (Coordinated Universal Time)
Med följande REST API kan du arbeta med DITA-kartor i AEM Guides.
Ladda ned DITA-karta med beroenden
En GET-metod som laddar ned en DITA-karta med alla dess beroenden, t.ex. refererade ämnen, delkartor, bilder och DTD:er som används på kartan och i avsnitten.
Begär URL:
http://<aem-guides-server>: <portnummer>/bin/fmdita/exportditamap
Parametrar:
Namn
Typ
Obligatoriskt
Beskrivning
ditamap
Sträng
Ja
Absolut sökväg för DITA-mappningsfilen i AEM.
baseline
Sträng
Nej
Titeln på baslinjen som används för att hämta versionsinnehållet.
Obs! Värdet är skiftlägeskänsligt.
Svarsvärden:
En ZIP-fil vars innehåll skrivs till svarets utdataström.
Initiera export för DITA-karta med beroenden
En metod som initierar en export av en DITA-POST med alla dess beroenden, t.ex. refererade ämnen, underkartor, bilder och DTD:er, som används på kartan och i avsnitten. Status kan efterfrågas senare och URL:en för nedladdningen kan hämtas när den är klar.
Begär URL:
http://<aem-guides-server>: <portnummer>/bin/dxml/async-export
Parametrar:
Namn
Typ
Obligatoriskt
Beskrivning
ditamap
Sträng
Ja
Absolut sökväg för DITA-mappningsfilen i AEM.
baseline
Sträng
Nej
Titeln på baslinjen som används för att hämta versionsinnehållet.
Obs! Värdet är skiftlägeskänsligt.
flatFS
Boolean
Nej
(Valfritt) Om värdet är true returneras en platt filstruktur i ZIP-filen. Om din DITA-karta till exempel refererar till innehåll i flera mappar, hämtas alla refererade filer till en enda mapp. Om det finns filer med samma namn byter dessa namn namn genom att lägga till ett numeriskt suffix. Alla referenser (i DITA-scheman och -ämnen) hanteras automatiskt när de uppdateras baserat på den nya platsen för filer i den platta mappstrukturen. Om värdet är false bevaras mappstrukturen som den är i ZIP-filen. Om DITA-kartan refererar till filer från flera platser skapas även alla dessa platser i ZIP-filen. När du återställer ZIP-filen skapas den exakta mappstrukturen på målplatsen.
Standardvärdet för den här parametern är false.
Svarsvärden:
status
Returstatus för den åtgärd som utfördes. Möjliga alternativ är: STARTAD, MISSLYCKAD, INPROGRESS, LYCKAD, SAKNAD, BORTTAGEN
jobId
Jobbets unika ID. Kan användas senare för att fråga efter status.
errorMessage
Felmeddelandet för jobbet vid fel (om statusen är MISSLYCKAD, SAKNAS eller DELETED).
filePath
Filsökvägen för ZIP. Den visas endast när jobbet har slutförts och statusen har LYCKATS. Detta kan användas för att hämta ZIP-filen.
Läsa DITA-mappningsstatus för export
En GET-metod som hämtar exportstatus för en DITA-karta med alla dess beroenden. Den kan avfrågas med ett intervall om statusen är STARTED eller INPROGRESS tills den är klar (lyckades eller med ett fel).
Begär URL:
http://<aem-guides-server>: <portnummer>/bin/dxml/async-export
Parametrar
Namn
Typ
Obligatoriskt
Beskrivning
jobId
Sträng
Ja
Jobb-ID som hämtades när exportjobbet initierades.
Svarsvärden:
status
Exportjobbets status. Möjliga alternativ är: STARTAD, MISSLYCKAD, INPROGRESS, LYCKAD, SAKNAD, BORTTAGEN
jobId
Jobbets unika ID. Kan användas senare för att fråga efter status.
errorMessage
Felmeddelandet för jobbet vid fel (om statusen är MISSLYCKAD, SAKNAS eller DELETED).
filePath
Filsökvägen för ZIP. Den visas endast när jobbet har slutförts och statusen har LYCKATS. Detta kan användas för att hämta ZIP-filen.