の定期メンテナンスにおける、更新情報

2019/05/12
kintone API Garoon API(2019/04/12)
2019年5月12日の定期メンテナンスの、kintone API および Garoon API の更新に関する情報をお知らせします。
お知らせの内容に追加、変更等ありましたら、こちらのコメントにて変更箇所を追記します。
また、APIドキュメントには仕様を順次公開していきます。
kintone JavaScript API

仕様変更
スマートフォン用のレコード一覧画面（カスタマイズビュー）の表示イベントが発生するタイミングを追加
対象API
レコード一覧画面の表示後イベント（mobile.app.record.index.show）
内容:
スマートフォンで、[レコード一覧の表示形式]が[カスタマイズ]の一覧において以下の操作を行ったときも、レコード一覧画面を表示したときのイベントが発生します。
ページ送りをした時
カテゴリーを変更した時
レコード一覧画面でソートの並び替えをした時スマートフォン用のレコード一覧画面（カスタマイズビュー）の表示イベントで取得できるプロパティを追加
対象API
レコード一覧画面の表示後イベント（mobile.app.record.index.show）
内容:
スマートフォンで、レコード一覧画面（[レコード一覧の表示形式]が[カスタマイズ]の場合）を表示したとき、event オブジェクトで以下のプロパティも取得できます。
viewType（値は「custom」固定です）
records
offsetsize

その他告知

用のレコード一覧画面の表示イベントが発生するタイミングを仕様に定義
対象API
レコード一覧画面の表示後イベント（app.record.index.show）
内容:
PCで、以下の操作を行ったときも、レコード一覧画面を表示したときのイベントが発生することを仕様に定義しました。
カテゴリーを変更した時
スマートフォン用のレコード一覧画面（表形式の一覧）の表示イベントが発生するタイミングを仕様に定義
対象API
レコード一覧画面の表示後イベント（mobile.app.record.index.show）
内容:
スマートフォンで、[レコード一覧の表示形式]が[表形式]の一覧において以下の操作を行ったときも、レコード一覧画面を表示したときのイベントが発生することを仕様に定義しました（2019年4月版より）。
カテゴリーを変更した時
レコード一覧画面でソートの並び替えをした時
PC

Garoon JavaScript API

機能追加の新規追加次の API が追加されます。
スケジュール：予定登録画面の登録実行前イベント
schedule.event.create.submit
予定登録画面で「登録する」ボタンをクリックした後に発生するイベントです。
次の登録画面または再利用画面で利用できます。
「通常予定」「期間予定」「繰り返し予定」
スケジュール：予定変更画面の変更実行前イベント
schedule.event.edit.submit
予定変更画面で「変更する」ボタンをクリックしたときに発生するイベントです。
次の変更画面で利用できます。
「通常予定」「期間予定」「繰り返し予定」
ワークフロー：フィールドの編集可/不可を設定する
workflow.request.setItemEditable
ワークフロー申請の作成画面で利用できます。
編集可/不可にできるフィールド
文字列（1行）
文字列（複数行）
ラジオボタン
チェックボックス
API数値
画像アセット：ファイルキーから画像 URL を取得する
garoon.assets.images.getUrl
PC 版のすべての画面（ポップアップ画面を除く）で利用できます。
「画像アセット」は、システム管理者向けの、画像ファイルを管理できるアプリケーションです。
今回のアップデートで追加される機能です。
「画像アセット」アプリケーションに画像ファイルを登録すると、JSカスタマイズで、登録した画像ファイルを配置できます。

仕様変更「スケジュール：予定の値をセットする」API の処理終了時の挙動
対象 API
スケジュール：予定の値をセットする
garoon.schedule.event.set
修正内容
対象 API の処理完了時に garoon.Promise オブジェクトが返却されます。
これにより、処理完了の通知を受け取ることができます。
変更前：undefined を返却
変更後： garoon.Promise オブジェクト を返却

不具合修正

代理承認者が、[代理承認一覧]から未処理申請処理画面を開いたときに、承認画面が表示されたときのイベントオブジェクトが返却されない対象 API
ワークフロー：ワークフロー申請の承認画面が表示されたときのイベン
ト
workflow.request.approve.show
修正内容
代理承認者が、「代理承認一覧」から「未処理申請の処理」画面を開いたとき
修正前：「ワークフロー申請の承認画面が表示された時のイベント」が返却されない
修正後：「ワークフロー申請の承認画面が表示された時のイベント」が返却される
Garoon REST API

機能追加の新規追加
次の API が追加されます。
API在席確認：在席情報を取得する
GET /presence/users/{id} （Garoon ユーザー ID を指定する場合）
GET /presence/users/code/{code} （Garoon ユーザーのログイン名を指定する場合）
次の内容を取得できます。
Garoon ユーザー情報
在席情報の「ステータス」「メモ」および「更新日時」
在席確認：在席情報を更新する
PATCH /presence/users/{id} （Garoon ユーザー ID を指定する場合）
PATCH /presence/users/code/{code} （Garoon ユーザーのログイン名を指定する場合）
在席情報の「ステータス」および「メモ」を更新します。
Garoon SOAP API

仕様変更
レスポンスヘッダーの API バージョンを変更（1.13.0→1.14.0）
対象API
すべて
Garoon SOAP APIの共通仕様：Garoon API のバージョン
修正前：クラウド版レスポンスヘッダーの apiversion 要素の値が 1.13.0
修正後：クラウド版レスポンスヘッダーの apiversion 要素の値が 1.14.0「アプリケーションの有効/無効を切り替える」API の対象アプリケーションに「画像アセット」を追加
対象API
アプリケーションの有効/無効 を切り替える
BaseManagerApplication
修正内容
リクエストパラメータ の属性 code に asset が設定できるようになります。
「アプリケーションの使用状況を取得する」API の対象アプリケーションに「画像アセット」を追加
対象 API
アプリケーションの使用状況を取得する
BaseGetApplicationStatus
修正内容
レスポンスとして返却されるアプリケーションの使用状況（BaseApplicationStatusType）に、code="asset" を持つ要素が含まれるようになります。
2019年2月アップデートの「ガルーンケータイ」機能の廃止に伴い、次の API で「ガルーンケータイ」に関する情報の取得および更新ができなくなります。
「アプリケーションの有効/無効を切り替える」API の対象アプリケーションから「ガルーンケータイ」を削除

対象API
アプリケーションの有効/無効 を切り替える
BaseManagerApplication
修正内容
リクエストパラメータ の属性 code に cellular が設定できなくなります。
「アプリケーションの使用状況を取得する」API のレスポンスから「ガルーンケータイ」の要素を削除
対象 API
アプリケーションの使用状況を取得する
BaseGetApplicationStatus
修正内容
レスポンスとして返却されるアプリケーションの使用状況（BaseApplicationStatusType）から、code="celluar" を持つ要素が含まれなくなります。
ワークフローの「利用権限を取得する」API のレスポンスから「ワークフローケータイの利用許可」を削除
対象 API
利用権限を取得する
WorkflowGetAvailabilityUsers
修正内容
レスポンスとして返却される user のデータ構造（WorkflowAvailabilityUserType）が変わります。
修正前：WorkflowAvailabilityUserType が持つパラメーター@id, @workflow, @ketai
修正後：WorkflowAvailabilityUserType が持つパラメーター@id, @workflow