本記事でできること
BizRobo!でKintoneのREST APIを使ったレコードの操作方法を紹介します。
APIを用いて開発をすることでKintoneと別システムの自動化が実現しやすくなると思います。
また、KintoneのAPIの使い方やBizRobo!でAPIを利用するための設定方法について理解できます。
背景
BizRobo!はステップの編集だけで簡単にデジタルレイバー(ロボット)を作成できるので非エンジニアの方にもなじみやすいのが特徴だと思います。
ただ、画面操作だけの開発だとクラウドサービスのアップデート等でUIが変更になるとロボットが止まってしまって改修に時間がかかってしまう、、、というケースも少なくないと思います。
そういった状況を解決するためにAPIを利用するという方法があります。
ただ、非エンジニアの方の中には「APIって高度なイメージがあって難しそう」「ステップの操作でも実行できるから充分」と思う方もいらっしゃると思います。(かくゆう私もそう思っていた時期がありました)
そのような方に向けて弊社で利用しているAPIとその使い方について紹介したいと思います。
本記事はサードパーティーのツールを利用するため、動作を保証するものではございません。
APIを利用するための参考としてお考え下さい。
事前準備
Kintoneの設定
※詳しくはkintone API ドキュメントやkintone ヘルプを参照してください。
利用バージョン
本記事で利用する各システムの情報は下記になります。
| 対象システム | 利用バージョン |
|---|---|
| BizRobo! | 11.3.0.2 |
| Kintone | 2023/12/14時点 |
ロボット作成
ゴール
クエリで条件を指定してKintoneアプリから複数のレコードを取得します。
取得したレコードのフィールドの値を変更して更新を行います。
値の変更を行うフォームは「要件」と「修正日」です。
ロボットの実行前後によるKintoneレコードの状態は以下になります。
| 実行前 | 実行後 |
|---|---|
 |
 |
手順
APIで特定のアプリからレコード情報を取得します。
その情報からレコード番号を抽出し、更新したいフィールドコードの値を設定しAPIで情報の更新を行います。
BizRobo!では以下のステップにて実現します。
左から順に①～⑤の手順で説明をしていきます。
①REST Webサービス呼出（Call REST Web Service）
Kintoneアプリから複数のレコードを取得するためにAPIを利用します。
アクションを選択からREST Webサービス呼出を選びます。
以下プロパティの指定です。
| プロパティ | 設定値 |
|---|---|
| URL |
https://sample.cybozu.com/k/v1/records.json (環境に応じて「sample」を書き換えてください) |
| リクエスト | GET |
| パラメータ | app = "アプリID" query = (レコードの条件を指定するクエリ) |
| ヘッダー | X-Cybozu-API-Token: API_TOKEN (環境に応じて「API_TOKEN」を書き換えてください) |
他はデフォルト値です。
②JSON形式表示（View as JSON）
アプリケーションエリアを右クリックして、開く（読み取り専用）を選択すると、ステップが追加されます。
③JSONアイテム繰り返し（For Each Item）
+アイコンをクリックして{}波括弧を開きます。recordsの上にカーソルを移動して右クリック、ループ>アイテムを選択すると、ステップが追加されます。
④JSON抽出（Extract レコード番号）
青枠のレコード番号のvalueの上にカーソルを移動して右クリック、抽出>テキスト>新しいシンプル タイプの変数>Short Textを選択します。
名前にレコード番号と入力してOKボタンをクリックします。
⑤REST Webサービス呼出（Call REST Web Service）
レコード番号を指定して、1件のレコードを更新します。
アクションを選択からREST Webサービス呼出を選びます。
以下プロパティの指定です。
| プロパティ | 設定値 |
|---|---|
| URL |
https://sample.cybozu.com/k/v1/records.json (環境に応じて「sample」を書き換えてください) |
| リクエスト | PUT ローボディを指定 |
| リクエストボディ | アプリIDとIDと更新したいフィールドを指定します。 (JSON形式で記述します。公式サイト) |
| コンテンツ タイプ | application/json |
| ヘッダー | X-Cybozu-API-Token: API_TOKEN (環境に応じて「API_TOKEN」を書き換えてください) |
他はデフォルト値です。
参考までにリクエストボディのコードを記述します。
>>{
"app": 2344,
"id": <<+レコード番号+>>,
"record": {
"要件": {
"value": "更新しました!"
},
"修正日": {
"value": "<<+date()+>>T<<+time(now())+>>+09:00"
}
}
}<<
以上でロボットの作成は完了になります。
まとめ
今回はKintoneのREST APIを利用してアプリからレコードを取得し、情報の更新を行ってみました。
APIを利用するとロボットの構築の幅が広がり、メンテナンス性も向上できると思います。
APIを利用したロボットの開発のための一助となれば幸いです。
RPAテクノロジーズでは、Kintoneを操作するコネクターをリリースしております。
より簡単に設定ができますのでぜひご利用ください。
利用する場合はこちら