ExcelからWebFOCUS REST APIを扱う
WebFOCUSを外部から制御したり、情報を参照したりするために提供されているインタフェースが、REST APIです。
REST APIは、メーカーからも正式に情報提供されており、サポート対象でもありますが、APIを制御するために使用するプログラム言語については、自己責任での使用となるため注意が必要です。REST APIそのものについての情報提供や問い合わせ対応は、サポート対象として問題ありません。
REST APIっていつ使うの？
WebFOCUS自体の操作や管理画面は、ブラウザからアクセスできるGUI画面が提供されており、通常はREST APIを使用することはないと思いますが、一括で取得・変更したい、バックグラウンドで連携したいなどのニーズがある場合に、REST APIを使用することがあります。
REST APIの利用イメージです。外部との連携で利用することが多いですが、一括処理や独自実装など、WebFOCUS自身との処理実装にも利用することができます。
本サンプルの使用方法
必ずリポジトリデータベースのバックアップを取得してください。
REST APIは、権限があれば、リポジトリデータベースに対して一括での操作を実施することができます。
誤って、すべての資産を削除するAPIを呼び出した場合でも、確認メッセージが表示されることもなく処理されます。すべてのユーザーを削除することもできます。資産が失われても、ログインできなくなっても、正しい処理として扱われるためです。REST API使用前に必ずバックアップを取得しておきましょう。
また、いきなり本番環境で実施するのではなく、影響が少ない開発環境で実施するようにしましょう。
サンプル利用前提
- Excelマクロを利用できるようにしてください
- REST APIを実行するためには、WebFOCUSの「Web Services」権限をREST APIを実行するユーザーやグループ、資源へ許可する必要があります
- ユーザー、グループなど、操作する対象によっては必要となる権限が異なってきますので、必要に応じて権限を付与してください
使用準備
本ページからサンプルファイルをダウンロードして、Excelが操作できて、WebFOCUSへ接続可能なPCの任意の場所へ配置してください。
サンプルコンテンツを使用する
接続定義設定
[TOP] シートを選択して、接続先情報など設定します。
- プロトコル： http か https
- ホスト名： 名前解決可能なホスト名 か IPアドレス
- ポート番号： 80 や 8080 や 443 など
- ユーザ名： REST API権限があるユーザID
- パスワード： 上記ユーザのパスワード
- 文字コード： UTF-8 か Shift-JIS を選択
リポジトリ情報一括取得・リスト化
実行するアクションを選択して、[実行] ボタンをクリックします。
※ 既存の対象シートは「実行」時に、
バックアップシートが作成されます
| アクション | 対象シート |
|---|---|
| ユーザのリスト表示 | User |
| グループのリスト表示 | Group |
| すべてのグループ内のユーザのリスト表示 | UsersInGroup |
| すべてのフォルダ内の項目のリスト表示 | ItemsInFolders |
リポジトリ情報一括更新
例：ユーザ情報更新
[UserUpdate] シートを選択して、[リポジトリDBの情報を取得] ボタンをクリックします。
「ユーザ情報の更新」リストへ、リポジトリデータベースのユーザ情報が列挙されます。
追加や更新を実施したい行の先頭列を「追加/更新」として、変更内容を入力します。
[リポジトリDBの情報を更新] ボタンをクリックします。
※ 更新後の状態を確認したい場合は、情報を再取得してください。
| 処理内容 | シート名 |
|---|---|
| ユーザ情報更新 | UserUpdate |
| グループ情報更新 | GroupUpdate |
| ユーザのグループ所属情報更新 | UserInGroupUpdate |
ExcelやExcel VBAについては、開発元メーカーや株式会社アシストのサポート対象外となります。
問題が発生した場合は、REST APIの動作についてかどうかを確認してください。
REST APIの問題か、本サンプルによる問題かの切り分けを実施してください。
REST APIの問題は、開発元メーカーや株式会社アシストのサポート対象となります。
ダウンロード
株式会社アシストおよび開発元メーカーは、本サンプルコンテンツの動作に関していかなる保証もいたしません。
また、本サンプルコンテンツの利用によって起因する問題についても責任を負いかねます。
本サンプルコンテンツに記載の技術情報およびプログラムは、特定の環境下において動作し、初期動作のみ確認をしております。
すべての個別環境にて動作することを想定していませんので、実装する実環境において、十分な動作確認をいただくことを推奨します。
また、システム環境の設定変更や導入製品のバージョンアップを実施した場合などの非互換については考慮されていません。
初期動作確認後、システム環境変更後の動作については、保証いたしませんので、ご了承ください。
サンプルコンテンツに含まれるプログラムなどの改変は、自由に実施していただいて問題ありませんが、新規要件やバグ修正などが発生した場合には、ご利用者様の責任範囲内での修正を実施いただくようお願いします。
サンプルコンテンツに含まれる、JavaScript,CSS,HTML,バッチファイル、シェルスクリプトなど、WebFOCUS製品サポートに関わらない箇所に関してのお問い合わせは、株式会社アシストの技術者、サポートセンターおよび開発元メーカーで受け付けることができません。WebFOCUSの動作に関するお問い合わせに限らせていただきます。
