DITA マップを操作するための REST API

最終更新日： 2024年9月12日

作成対象：

次の REST API を使用すると、AEM Guidesで DITA マップを操作できます。

依存を含む DITA マップのダウンロード

参照されるトピック、サブマップ、イメージ、マップおよびトピックで使用される DTD など、DITA マップをその依存とともにダウンロードするGET方式。

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

パラメーター:

名前	型	必須	説明
`ditamap`	文字列	はい	AEM リポジトリの DITA マップファイルの絶対パス。
`baseline`	文字列	いいえ	バージョン管理されたコンテンツを取得するために使用されるベースラインのタイトル。メモ：この値では大文字と小文字が区別されます。

応答値:
応答の出力ストリームにコンテンツが書き込まれる.zip ファイル。

参照トピック、サブマップ、イメージ、マップおよびトピックで使用される DTD など、DITA マップのすべての依存を使用して DITA マップの書き出しを開始するPOST方式。後でステータスをクエリし、完了したらダウンロード URL を取得できます。

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

パラメーター:

名前	型	必須	説明
`ditamap`	文字列	はい	AEM リポジトリの DITA マップファイルの絶対パス。
`baseline`	文字列	いいえ	バージョン管理されたコンテンツを取得するために使用されるベースラインのタイトル。メモ：この値では大文字と小文字が区別されます。
`flatFS`	ブール値	いいえ	\（オプション\） true に設定すると、ファイルのフラット構造が ZIP ファイルで返されます。たとえば、DITA マップが複数のフォルダ内のコンテンツを参照する場合、参照されるすべてのファイルが 1 つのフォルダに取り込まれます。同じ名前のファイルが存在する場合は、数字のサフィックスを追加して名前を変更します。すべての参照\（in DITA map and topics\）は、フラットフォルダ構造内のファイルの新しい場所に基づいて更新されるため、自動的に処理されます。 false に設定した場合、フォルダー構造は ZIP ファイルにそのまま保持されます。 DITA マップが複数の場所からファイルを参照する場合、これらすべての場所も ZIP ファイルに作成されます。 ZIP ファイルを復元すると、正確なフォルダー構造が復元先の場所に作成されます。このパラメーターのデフォルト値は false です。

応答値:

要素	説明
`status`	実行された操作の復帰ステータス。使用可能なオプションは「開始済み」、「失敗」、「進行中」、「成功」、「見つからない」、「削除」です
`jobId`	ジョブの一意の ID。後でステータスのクエリに使用できます。
errorMessage	失敗時のジョブのエラーメッセージ\（ステータスが FAILED、MISSING または DELETED\）。
`filePath`	ZIP のファイルパス。ジョブが完了し、ステータスが「成功」の場合にのみ存在します。これを使用して、ZIP ファイルをダウンロードできます。

すべての依存を持つ DITA マップの書き出しステータスを取得するGETメソッド。ステータスが STARTED または INPROGRESS の場合は、終了\（正常またはエラー\）するまでポーリングできます。

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

パラメーター:

名前	型	必須	説明
`jobId`	文字列	はい	エクスポートジョブの開始時に取得されたジョブ ID。

応答値:

要素	説明
`status`	エクスポートジョブのステータス。使用可能なオプションは「開始済み」、「失敗」、「進行中」、「成功」、「見つからない」、「削除」です
`jobId`	ジョブの一意の ID。後でステータスのクエリに使用できます。
`errorMessage`	失敗時のジョブのエラーメッセージ\（ステータスが FAILED、MISSING または DELETED\）。
`filePath`	ZIP のファイルパス。ジョブが完了し、ステータスが「成功」の場合にのみ存在します。これを使用して、ZIP ファイルをダウンロードできます。

recommendation-more-help