Workiva サポートセンター

はじめに

APIコレクションのセットアップに基づき、この記事ではWorkiva APIを使用してWorkivaからファイルをエクスポートする方法を説明します。このガイドは輸出時に適用されます：

• .PDF,.DOCX, または.XHTML のドキュメント
• .XLSX,.PDF, または.CSV としてスプレッドシート
• .PDF または.PPTX でのプレゼンテーション

.tar.gz フォーマットのネイティブ Workiva ファイルをエクスポートするための追加オプションが利用可能です。

前提条件

先に進む前に、Workiva API CollectionsをPostmanにインポートする ガイドのすべての手順を完了していることを確認してください。

認証

1. Postmanのワークスペースを開き、正しい環境が選択されていることを確認する。

2. IAM Services コレクションを展開し、OAuth2 フォルダを開き、Retrieve a token を選択します。

   

3. Send をクリックして認証トークンを生成します。このトークンは自動的に{{access_token}} 環境変数に格納され、以降のすべてのリクエストで使用されます。

注： アクセストークンの有効期限は600秒（10分）です。有効期限が切れたら、この手順を繰り返して新しいトークンを生成する。

ファイルエクスポートの開始（ドキュメント、プレゼンテーション、スプレッドシート）

この例では、Workiva ドキュメントを.PDF 、.DOCX 、.XHTML としてエクスポートすることに焦点を当てています。スプレッドシートやプレゼンテーション をエクスポートする場合も、同じコンセプトが適用されます。

1. Platform API コレクションを展開し、Documents →Document ID →Export.
2. 文書のエクスポートを開始する リクエストを開きます。
3. Parameters タブで、documentId を入力する。
4. リクエスト・ボディを更新して、エクスポート・フォーマット を指定する：

   • PDF

     { "pdfOptions"：{includeAlternateRowFill": true, "includeAttachmentLabels": true, "includeComments": true, "includeDraftWatermark": true, "includeHyperlinks": true：true, "includeLeaderDots": true, "includeTrackChanges": true, "tagForWebAccessibility": true, "useCmykColorspace": true }, "format": "pdf", "sections"：[] }

   • DOCX

     { "docxOptions"：{includeLeaderDots": true, "showTableCellShading": true }, "format": "docx", "sections"：[] }

   • XHTML

     { "xhtmlOptions"：{editableSimple": true, "editableXhtml": false, "includeExternalHyperlinks": false, "includeHeadersAndFooters": false }, "format": "xhtml", "sections"：[] }

5. エクスポートを開始するリクエストを送信します。このプロセスは3つのステップからなる：

   • POSTリクエストを送信する。レスポンスには、URLを含むLocation ヘッダーが含まれる。

     

   • Location ヘッダーの URL に GET リクエストを行い、エクスポートステータスをチェックし、処理が完了したらリソース URL を取得する。

     

   • リソース URL を使って最後の GET リクエストを行い、エクスポートされたファイルをダウンロードする。

     

エクスポートされたファイルはバイナリデータとして返される。これは想定内の行動です。適切な拡張子を使用してファイルを保存するだけです（例えば、.pdf 、.docx 、.xhtml ）。

次に、API Collection を使用して、ファイルをインポートする方法を確認します。