承認ワークフロー一覧のエンドポイント(Approvalflow::list)の仕様変更について
公開日:2026-11-11
2027年1月の正式版で、承認ワークフロー一覧のエンドポイント(Approvalflow::list)の動作を変更します。影響と対応は、エンドポイント設定でmodule_typeを指定しているかどうかで異なります。ご利用のエンドポイント設定をご確認のうえ、反映までに対応をお願いします。
module_typeを指定していない場合
変更の内容
- 次の条件をすべて満たすワークフローだけを返すようになります。現在は絞り込みを行わず、無効なワークフローも返しています。
- 呼び出した会員が申請できる(ワークフローの[利用制限]が[選択なし]、または[利用制限]で選択したグループに会員が所属している)
- 有効になっている
- 承認者が1人以上設定されている
- クエリパラメータの
cntを省略した場合、1ページ20件ではなく全件を返し、pageInfoはtotalCntだけになります。このとき、クエリパラメータのpageIDを指定しても無視されます。 - クエリパラメータの
per_pageは利用できなくなります。
対応
- 現在と同様にすべてのワークフローを取得したい場合は、エンドポイント設定の
ignore_apply_restrictionとignore_enable_flgを有効にしてください。2つのパラメータは2026年10月の正式版で追加済みです。module_typeを指定していない場合は、現在は設定しても動作が変わらないため、事前に設定できます。 - 承認者が1人も設定されていないワークフローは、2つのパラメータの設定に関わらず返らなくなります。
- クエリパラメータの
pageIDでページを送っている場合や、pageInfoのtotalCnt以外の項目を参照している場合は、クエリパラメータのcntに1以上の件数を指定してください。現在cntを指定していない場合は、cnt=20を指定すると現在と同じ1ページ20件になります。cntは2026年10月の正式版で追加済みのため、事前に指定できます。 - クエリパラメータの
per_pageで件数を指定している場合は、cntに変更してください。
module_typeを指定している場合
変更の内容
権限の確認
エンドポイント設定に関わらず、呼び出した会員が次の権限を持っているかを常に確認するようになります。ログインした状態(Cookie、動的アクセストークン、または特権付き静的トークンによる認証)で、次の権限を持つ会員として呼び出す必要があります。未ログインで呼び出した場合や、権限を持たない会員で呼び出した場合は、403エラーになります。権限を持つ会員で呼び出した場合に返すワークフローは変わりません。
module_type | 必要な権限 |
|---|---|
topics(module_idを指定) | 承認ワークフローの閲覧権限、またはmodule_idで指定したコンテンツ定義の更新権限 |
topics(module_idを指定しない) | 承認ワークフローの閲覧権限だけ(コンテンツの更新権限では呼び出せません) |
inquiry / csvtable / tag | 承認ワークフローの閲覧権限、または対象のモジュールの更新権限 |
現在は、権限を確認せずに一覧を返す場合があります。
cntを省略した場合のpageInfo
クエリパラメータのcntを省略した場合、pageInfoはtotalCntだけになります。現在はtotalCnt、perPage、totalPageCnt、pageNoを返しています。全件を返すことは変わりません。
対応
- 未ログインで呼び出している場合や、権限を持たない会員で呼び出している場合は、権限を持つ会員でログインした状態で呼び出すように変更してください。現在の動作を維持するための設定はありません。
cntを省略してpageInfoのperPage、totalPageCnt、pageNoを参照している場合は、totalCntを参照するように変更してください。現在、cntを省略した場合のperPageはtotalCntと同じ値で、totalPageCntとpageNoは常に1です。
反映時期
2027年1月の正式版で反映される予定です。
お問い合わせ先
本件についてご不明点がございましたら、Kurocoサポートまでお気軽にお問い合わせください。
関連ドキュメント
サポート
お探しのページは見つかりましたか?解決しない場合は、問い合わせフォームからお問い合わせいただくか、Slackコミュニティにご参加ください。