はじめに
この記事では、Workiva API コレクションを使用して、Workiva にファイルをインポートする手順を説明します。
前提条件
Workiva API Collections を Postman にインポートする ガイドのすべてのステップを正常に完了している必要があります。
認証
- postmanのワークスペースを開き、正しい環境を選択してください。
-
oauth2 フォルダ、auth2 フォルダの順に展開し、Retrieve a token リクエストを開きます。
- Send をクリックしてこのリクエストを実行し、認証トークンを生成します。このトークンは{{access_token}}環境変数に自動的に格納され、実行するすべてのエンドポイントリクエストに自動入力されます。
注:トークンは600秒(10分)後に失効しますので、新しいトークンを生成するにはこの手順を繰り返す必要があります。
ファイルのインポートを開始する
- Workiva API コレクション、Files、Importフォルダの順に展開します。
- ファイルインポート リクエストを開始します。
-
リクエスト・ボディ を編集する。
- FileName :インポートするファイル名。対応する拡張子には(.xlsx、.csv、.docx、.pptx、.vsdx、.tar.gz)
-
種類 :アップロードする Workiva ファイルの種類(Document, Spreadsheet, Presentation )。
- POSTリクエストを送信する。
- Body から返されたUploadUrlをコピーする。
- 新しいPUTリクエストを作成し、前のリクエストからUploadURLを入力する。
- ボディタブを選択し、バイナリーオプション を選ぶ。
- Select file ドロップダウンから、ローカルマシンからアップロードするファイルを選択します。
- ファイルタイプが前のリクエストで指定されたタイプと一致していることを確認する。例えば、kind = Document の場合、アップロードするファイルは.docx ファイルでなければなりません。
-
送信をクリックする
- 200 レスポンスが表示されるはずです。
-
次にWorkivaをチェックすると、ファイルがあるはずです。この例では、Workivaのドキュメント形式になっています。
次に、API Collection を使用して、ファイルをエクスポートする方法を確認します。