下記の仕様変更を予定しています。
内容をご確認いただき、影響がある場合は対処頂きますようお願い致します。
内容についてご不明な点がある場合は、弊社サポートセンターへお問い合わせください。
背景
RestAPIで文書一覧のデータを取得する際に、下記の条件に合致するような場合には時間がかかる問題があります。
- 対象のビューにバインダ参照ボタンが定義されている
- １ページの件数が多い
この問題はバインダ参照で参照している先の文書データも取得することから発生しています。
これを解消するため、バインダ参照先の文書の情報を取得するかどうかを指定するパラメータを追加します。
現在の仕様
- 対象RestAPIの戻り値において、バインダ参照ボタンに値があれば常にバインダ参照先の文書のデータ（refDocs）を取得する。
変更後の仕様
- 対象RestAPIの戻り値において、バインダ参照ボタンがあってもバインダ参照先の文書のデータ（refDocs）を取得しない。
- 取得する場合はパラメータ（loadRefDoc=true）を明示的に指定して取得する。
変更予定
- 2022/04/01 深夜メンテナンス以降
対象RestAPI
- 文書一覧取得
GET: /hibiki/rest/2/binders/{binder}/views/{view}/documents - 文書新規登録
POST: /hibiki/rest/2/binders/{binder}/documents - 文書更新
PUT: /hibiki/rest/2/binders/{binder}/documents/{recordId} - 文書詳細情報取得
GET: /hibiki/rest/2/binders/{binder}/documents/{recordId} - 文書詳細情報取得（ビュー定義より）
GET: /hibiki/rest/2/binders/{binder}/views/{view}/documents/{recordId} - リスト型部品一覧取得
GET: /hibiki/rest/2/binders/{binder}/documents/{document}/listitems/{block} - リスト型部品の行新規登録
POST: /hibiki/rest/2/binders/{binder}/documents/{document}/listitems/{block}/rows - リスト型部品の行更新
PUT: /hibiki/rest/2/binders/{binder}/documents/{document}/listitems/{block}/rows/{row} - 文書再利用の詳細情報取得
GET: /hibiki/rest/2/binders/{binder}/documents/{recordId}?operation=reuse - アクティビティ詳細情報取得
GET: /hibiki/rest/2/activities/{activityId}
影響
リリース後は、該当のRestAPIでバインダ参照先の文書の情報（refDocs）を取得できなくなります。
バインダ参照先の情報を利用している場合は、2022/04/01の仕様変更までにパラメータ（loadRefDoc=true）を明示的に指定して取得するようにしてください。
※ 仕様変更前にパラメータを指定しても無視されるためエラーにはなりません。
※ 参照先のデータを評価式を用いて保持している場合は影響ありません。