用於輸出管理的REST API id175UB30E05Z

下列REST API可用於管理AEM Guides中的輸出。

取得DITA map的所有輸出預設集 get-output-presets-dita-map

一種POST方法，可擷取為DITA map設定的所有輸出預設集。

請求URL： http://<aem-guides-server>： <port-number>/bin/publishlistener

引數：
|名稱|型別|必要|說明| --------------------------- |:operation|字串|是|要呼叫的作業名稱。 此引數的值為 getalloutputs.
注意： 值不區分大小寫。| |sourcePath|字串|是|DITA map檔案的絕對路徑。|

回應值：傳回JSON輸出預設集物件陣列，每個物件包含下列元素：

建立輸出預設集

一種為DITA map建立新輸出預設集的POST方法。

請求URL： http://<aem-guides-server>： <port-number>/bin/publishlistener

引數： |名稱|型別|必要|說明| --------------------------- |:operation|字串|是|要呼叫的作業名稱。 此引數的值為 createoutput.
注意： 值不區分大小寫。| |sourcePath|字串|是|DITA map檔案的絕對路徑。| |outputTitle|字串|是|輸出預設集設定的描述性名稱。 這可用來定義輸出預設集的「設定名稱」屬性值。
注意： 建立新的輸出預設集時，後端系統從給定標題為輸出預設集驅動唯一名稱。| |outputType|字串|是|使用此預設集產生的輸出型別，例如AEM網站、PDF、EPUB或其他。 可用的選項包括：
- AEMSITE
-PDF
-HTML5
-EPUB
— 自訂|

回應值： |元素|說明| -------|-----------| |outputName|新建立的輸出預設集的唯一名稱。 此名稱衍生自 outputTitle 引數。|

儲存輸出預設集

一種POST方法，可儲存輸出預設集中所做的變更。

請求URL： http://<aem-guides-server>： <port-number>/bin/publishlistener

引數： |名稱|型別|必要|說明| --------------------------- |:operation|字串|是|要呼叫的作業名稱。 此引數的值為 saveoutput.
注意： 值不區分大小寫。| |sourcePath|字串|是|DITA map檔案的絕對路徑。| |outputObj|字串|是|包含正在更新之輸出預設集屬性的JSON物件。 此 outputObj.outputName 屬性包含要更新的輸出預設集名稱。 如需JSON物件的格式，請參閱 回應值 中的表格 取得DITA map的所有輸出預設集.|

回應值：傳回HTTP 200 (Successful)回應。

取得特定的輸出預設集

一種POST方法，可擷取現有的輸出預設集。

請求URL： http://<aem-guides-server>： <port-number>/bin/publishlistener

引數： |名稱|型別|必要|說明| --------------------------- |:operation|字串|是|要呼叫的作業名稱。 此引數的值為 getoutput.
注意： 值不區分大小寫。| |sourcePath|字串|是|DITA map檔案的絕對路徑。| |outputName|字串|是|必須擷取其詳細資訊的輸出預設集名稱。|

回應值： |元素|說明| -------|-----------| |outputName|輸出預設集名稱。 輸出名稱在其定義的DITA map範圍內是唯一的。| |outputType|使用此預設集產生的輸出型別，例如AEM網站、PDF、EPUB或其他。 可用的選項包括：
- AEMSITE
-PDF
-HTML5
-EPUB
— 自訂
| |outputTitle|輸出預設集設定的描述性名稱。 這可用來定義輸出預設集的「設定名稱」屬性值。| |ditaValPathList|要用來產生所要輸出的DITAVAL檔案路徑陣列。| |targetPath|發佈或儲存輸出的路徑。| |siteName|(用於AEM網站輸出) AEM網站的名稱。| |siteTitle|(用於AEM網站輸出) AEM網站的標題。| |templatePath|(針對AEM網站輸出)要用來產生所要輸出的範本節點路徑。| |searchScope|指定搜尋操作的範圍。 此引數的值必須設為 local.| |generateTOC|(用於AEM網站輸出)指定是否產生TOC (true) (false)。| |generateBreadcrumbs|(用於AEM網站輸出)指定是否產生階層連結(true) (false)。| |overwriteFiles|(用於AEM網站輸出)指定是否覆寫目的地的檔案(true) (false)。| |pdfGenerator|指定要使用的PDF產生引擎。 可能的值包括：
- DITAOT
- FMPS|

產生輸出

使用一或多個輸出預設集產生輸出的GET方法。

請求URL： http://<aem-guides-server>： <port-number>/bin/publishlistener

引數： |名稱|型別|必要|說明| --------------------------- |operation|字串|是|要呼叫的作業名稱。 此引數的值為 GENERATEOUTPUT.
注意： 值區分大小寫。| |source|字串|是|DITA map檔案的絕對路徑。| |outputName|字串|是|要用於產生輸出的輸出預設集名稱。 例如，可以使用垂直號(「|」)分隔符號指定多個輸出預設集 aemsite|pdfoutput.|

回應值：傳回HTTP 200 (Successful)回應。

產生增量輸出

使用一或多個輸出預設集為AEM Site產生增量輸出的GET方法。

請求URL： http://<aem-guides-server>： <port-number>/bin/publishlistener

引數： |名稱|型別|必要|說明| --------------------------- |operation|字串|是|要呼叫的作業名稱。 此引數的值為 INCREMENTALPUBLISH.
注意： 值區分大小寫。| |contentPath|JSON|是|DITA map檔案和主題檔案的絕對路徑，以及輸出預設集的名稱。 使用下列範例作為建置區塊：|

{
   {
   "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"
      ]
   }
}

回應值：傳回HTTP 200 (Successful)回應。

刪除輸出預設集

刪除輸出預設集的POST方法。

請求URL： http://<aem-guides-server>： <port-number>/bin/publishlistener

引數： |名稱|型別|必要|說明| --------------------------- |:operation|字串|是|要呼叫的作業名稱。 此引數的值為 deleteoutput.
注意： 值不區分大小寫。| |sourcePath|字串|是|DITA map檔案的絕對路徑。| |outputName|字串|是|要刪除的輸出預設集名稱。|

回應值：傳回HTTP 200 (Successful)回應。