出力管理用の REST API id175UB30E05Z

AEMガイドの出力の管理には、次の REST API を使用できます。

DITA マップのすべての出力プリセットを取得します get-output-presets-dita-map

DITA マップ用に設定されたすべての出力プリセットを取得するPOSTメソッド。

リクエスト URL: http://<aem-guides-server>: <port-number>/bin/publishlistener

パラメーター:
|名前|型|必須|説明| |—|—|—|—| |:operation|String|はい|呼び出される操作の名前。 このパラメーターの値は、 getalloutputs.
注意： 値では大文字と小文字が区別されません。| |sourcePath|String|はい|DITA マップファイルの絶対パス。|

応答値:JSON 出力プリセットオブジェクトの配列を戻します。各オブジェクトには次の要素が含まれます。

出力プリセットを作成

DITA マップの新しい出力プリセットを作成するPOSTメソッド。

リクエスト URL: http://<aem-guides-server>: <port-number>/bin/publishlistener

パラメーター: |名前|型|必須|説明| |—|—|—|—| |:operation|String|はい|呼び出される操作の名前。 このパラメーターの値は、 createoutput.
注意： 値では大文字と小文字が区別されません。| |sourcePath|String|はい|DITA マップファイルの絶対パス。| |outputTitle|String|はい|出力プリセット設定のわかりやすい名前。 これは、出力プリセットの「設定名」プロパティの値を定義するために使用されます。
注意： 新しい出力プリセットが作成されると、バックエンドシステムは、指定されたタイトルからの出力プリセットの一意の名前を駆動します。| |outputType|文字列|はい|このプリセットを使用して生成される出力のタイプ (AEMサイト、PDF、EPUBなど )。 使用可能なオプションは次のとおりです。
- AEMSITE
-PDF
-HTML5
-EPUB
— カスタム|

応答値: |要素|説明| |—|—| |outputName|新しく作成された出力プリセットの一意の名前。 この名前は outputTitle パラメーター。|

出力プリセットを保存

出力プリセットでおこなった変更を保存するPOST方法。

リクエスト URL: http://<aem-guides-server>: <port-number>/bin/publishlistener

パラメーター: |名前|型|必須|説明| |—|—|—|—| |:operation|String|はい|呼び出される操作の名前。 このパラメーターの値は、 saveoutput.
注意： 値では大文字と小文字が区別されません。| |sourcePath|String|はい|DITA マップファイルの絶対パス。| |outputObj|String|Yes|更新中の出力プリセットのプロパティを含む JSON オブジェクト。 The outputObj.outputName プロパティには、更新する出力プリセットの名前が含まれます。 JSON オブジェクトの形式については、 応答値 テーブル DITA マップのすべての出力プリセットを取得します.|

応答値:HTTP 200 (Successful) 応答を戻します。

特定の出力プリセットの取得

既存の出力プリセットを取得するPOSTメソッド。

リクエスト URL: http://<aem-guides-server>: <port-number>/bin/publishlistener

パラメーター: |名前|型|必須|説明| |—|—|—|—| |:operation|String|はい|呼び出される操作の名前。 このパラメーターの値は、 getoutput.
注意： 値では大文字と小文字が区別されません。| |sourcePath|String|はい|DITA マップファイルの絶対パス。| |outputName|文字列|はい|詳細を取得する必要がある出力プリセットの名前。|

応答値: |要素|説明| |—|—| |outputName|出力プリセットの名前。 出力名は、定義されている DITA マップの範囲で一意です。| |outputType|このプリセットを使用して生成される出力のタイプ (AEMサイト、PDF、EPUBなど )。 使用可能なオプションは次のとおりです。
- AEMSITE
-PDF
-HTML5
-EPUB
— カスタム
| |outputTitle|出力プリセット設定のわかりやすい名前。 これは、出力プリセットの「設定名」プロパティの値を定義するために使用されます。| |ditaValPathList|目的の出力の生成に使用する DITAVAL ファイルのパスの配列。| |targetPath|出力が公開または保存されるパス。| |siteName|(AEM Site の出力) AEMサイトの名前。| |siteTitle|(AEM Site の出力用)AEMサイトのタイトル。| |templatePath|(AEM Site の出力用) 目的の出力の生成に使用するテンプレートノードのパス。| |searchScope|検索操作の範囲を指定します。 このパラメーターの値はに設定する必要があります local.| |generateTOC|(AEMサイト出力の場合)TOC が生成されるか(true) 生成されないか(false) を指定します。| |generateBreadcrumbs|(AEMサイト出力の場合) パンくずリストを生成するか(true) 生成しないか(false) を指定します。| |overwriteFiles|(AEM Site の出力の場合) 宛先のファイルが上書きされるか(true)、(false) のどちらでないかを指定します。| |pdfGenerator|使用するPDF生成エンジンを指定します。 次の値を指定できます。
- DITAOT
- FMPS|

出力を生成

1 つ以上の出力プリセットを使用して出力を生成するGETメソッド。

リクエスト URL: http://<aem-guides-server>: <port-number>/bin/publishlistener

パラメーター: |名前|型|必須|説明| |—|—|—|—| |operation|String|はい|呼び出される操作の名前。 このパラメーターの値は、 GENERATEOUTPUT.
注意： 値では大文字と小文字が区別されます。| |source|String|はい|DITA マップファイルの絶対パス。| |outputName|文字列|はい|出力の生成に使用する出力プリセットの名前。 複数の出力プリセットは、例えばパイプ (「|」) の区切り文字を使用して指定できます。 aemsite|pdfoutput.|

応答値:HTTP 200 (Successful) 応答を戻します。

増分出力を生成

1 つ以上の出力プリセットを使用してAEM Site の増分出力を生成するGETメソッド。

リクエスト URL: http://<aem-guides-server>: <port-number>/bin/publishlistener

パラメーター: |名前|型|必須|説明| |—|—|—|—| |operation|String|はい|呼び出される操作の名前。 このパラメーターの値は、 INCREMENTALPUBLISH.
注意： 値では大文字と小文字が区別されます。| |contentPath|JSON|はい|DITA マップファイルとトピックファイルの絶対パスと出力プリセットの名前。 構築ブロックとして次の例を使用します。|

{
   {
   "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|String|はい|呼び出される操作の名前。 このパラメーターの値は、 deleteoutput.
注意： 値では大文字と小文字が区別されません。| |sourcePath|String|はい|DITA マップファイルの絶対パス。| |outputName|String|はい|削除する出力プリセットの名前。|

応答値:HTTP 200 (Successful) 応答を戻します。