はじめに
この記事では、Workiva APIを使用してWdataのファイルを置き換える方法を説明します。既存のファイルを取得し、アンインポートして削除してから、新しいバージョンをアップロードします。
前提条件
始める前に、Workiva API CollectionsをPostmanにインポートする ガイドのすべての手順を完了していることを確認してください。これにより、APIコレクションと環境変数が正しく設定されていることが確認される。
認証
- Postmanのワークスペースを開き、正しい環境を使用していることを確認する。
- IAM Services コレクションを展開し、oauth2 フォルダを開き、Retrieve a token リクエストを選択します。
- Send をクリックして、認証トークンを生成します。トークンは自動的に{{access_token}} 環境変数に格納され、以降のすべてのAPIコールで使用される。
注： トークンの有効期限は600秒（10分）です。このような場合は、この手順を繰り返すだけで、新しいものが生成される。
Retrieve a List of Files APIを使ってファイルIDを取得する
Wdataテーブル内のファイルをアップロードまたは置換する前に、そのファイルが既に存在するかどうかを確認してください。これは、Retrieve a List of Files APIを使ってファイルを探し、そのFile ID を取得することで可能です。
以下の手順に従ってください。
- APIエンドポイントを開く
- Wdata API → File →Retrieve List of Files.
- 必要なパラメータを入力する
- TableId: WdataテーブルID
- SearchText: ファイル名（例：
管理表（3）.csv)
- リクエストを実行する
- APIは、検索条件に一致するすべてのファイルを返します。
- ファイルIDの検索
- JSONレスポンスの中で、次のものを探す：
-
id→ ファイルID -
name→正しいファイルを確認
-
- JSONレスポンスの中で、次のものを探す：
(オプション）Wdataで確認
UIでデータセットを開き、ファイルIDが一致することを確認する。
ファイルIDを使用してファイルをアンインポートする
Wdata テーブルからインポートしたファイルを削除するには、Unimport a single file エンドポイントを使用します。このステップでは、テーブルが交換ファイルを受け取る準備をする。
- Postmanで、Unimport a single file requestを開く。
- パス変数 で、設定する：
- Send をクリックしてリクエストを実行する。
- レスポンス・ボディで、ファイル・レコードが更新されたステータス （たとえば、ステージ に戻された）を示していることを確認する。
-
Wdata → Datasets で、データセットを開き、ファイルがインポートされたと表示されなくなったことを確認する。
ファイルIDを使用してファイルを削除する
- Postmanで、Delete a single file requestを開く。
- パス変数 に、同じfileId を貼り付ける。
- リクエストを送信します。
- レスポンス・ボディがfileId を返すことを確認する。
オプション：force=trueを使用して、インポートの解除とファイルの削除を一度に行う。
デフォルトでは、ファイルがアンインポートされると、そのファイルはテーブルから削除され、ステージング・モードに戻るが、削除はされない。単一の操作の一部としてファイルを永久に削除するには、force クエリーパラメーターを含めます。
force=true が指定された場合、ファイルは1回のリクエストでアンイン ポートされ、削除される。別途Delete a single file API 呼び出しは必要ない。
例：
DELETE /api/v1/table/{tableId}/import/{fileId}?force=true 新しいファイルをアップロードする
以前のファイルを削除した後、ファイルのアップロードとインポート ガイドの手順に従って、新しいバージョンをアップロードしてインポートします。