使用DITA map的REST API id175UB30E05Z

下列REST API可讓您在AEM Guides中使用DITA map。

下載具有相依物件的DITA map

一種GET方法,可下載DITA map及其所有相依專案,例如參照的主題、子地圖、影像以及在地圖和主題中使用的DTD。

請求URL: http://<aem-guides-server><port-number>/bin/fmdita/exportditamap

引數: |名稱|型別|必要|說明| --------------------------- |ditamap|字串|是|AEM存放庫中DITA map檔案的絕對路徑。| |baseline|字串|否|用來擷取已建立版本之內容的基準標題。
注意: 值區分大小寫。 |

回應值:其內容會寫入回應的輸出資料流的.zip檔案。

啟動具有相依物件的DITA map匯出

一種POST方法,會啟動DITA map及其所有相依專案(例如參照的主題、子地圖、影像以及在地圖和主題中使用的DTD)的匯出。 稍後可以查詢狀態,並在完成後擷取下載URL。

請求URL: http://<aem-guides-server>: <port-number>/bin/dxml/async-export

引數: |名稱|型別|必要|說明| --------------------------- |ditamap|字串|是|AEM存放庫中DITA map檔案的絕對路徑。| |baseline|字串|否|用來擷取已建立版本之內容的基準標題。
注意: 值區分大小寫。| |flatFS|Boolean|No|(Optional)如果設為true,則會在ZIP檔案中傳回檔案的平面結構。 例如,如果您的DITA map參照多個資料夾中的內容,則所有參照的檔案都會提取到單一資料夾中。 如果存在同名檔案,則會新增數值尾碼以重新命名這些檔案。 所有參照\(在DITA map和主題中\)都會自動處理,因為它們會根據平面資料夾結構中檔案的新位置進行更新。 如果設為false,則會維持資料夾結構在ZIP檔案中的原樣。 如果DITA map參照來自多個位置的檔案,則所有這些位置也會在ZIP檔案中建立。 還原ZIP檔案時,會在目的地位置建立精確的資料夾結構。
此引數的預設值為false。|

回應值: |元素|說明| -------|-----------| |status|所執行作業的傳回狀態。 可能的選項包括:「已開始」、「失敗」、「進行中」、「成功」、「缺少」、「已刪除」| |jobId|工作的唯一識別碼。 稍後可用於查詢狀態。| |errorMessage|發生失敗時工作的錯誤訊息\(如果狀態為FAILED、MISSING或DELETED\)。| |filePath|壓縮檔的檔案路徑。 只有在工作完成且狀態為「成功」時,才會出現此選項。 這可用來下載ZIP檔案。|

查詢匯出DITA map狀態

一種GET方法,可擷取DITA map及其所有相依物件的匯出狀態。 如果狀態為STARTED或INPROGRESS,可以間隔輪詢直到輪詢完成\(成功或有錯誤\)。

請求URL: http://<aem-guides-server>: <port-number>/bin/dxml/async-export

引數
|名稱|型別|必要|說明| --------------------------- |jobId|字串|是|啟動匯出作業時擷取的作業識別碼。|

回應值: |元素|說明| -------|-----------| |status|匯出作業的狀態。 可能的選項包括:「已開始」、「失敗」、「進行中」、「成功」、「缺少」、「已刪除」| |jobId|工作的唯一識別碼。 稍後可用於查詢狀態。| |errorMessage|發生失敗時工作的錯誤訊息\(如果狀態為FAILED、MISSING或DELETED\)。| |filePath|壓縮檔的檔案路徑。 只有在工作完成且狀態為「成功」時,才會出現此選項。 這可用來下載ZIP檔案。|

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