2024-11-18

Topics::draft_list のレスポンス構造が変わります

Topics::draft_listのレスポンスは途中保存のデータをlist形式で出力していましたが、デフォルトで全件出力となっていました。
途中保存のデータ数が増えた場合に対応できるよう、デフォルトのレスポンスを20件とし、pageInfoの情報を追加します。

必要に応じてcntのパラメータを設定するか、pageInfoを利用したページネーションを実装してください。

変更内容

• cntを指定しない場合の途中保存のレスポンスが20件になります。
• レスポンスにpageInfoが追加されます。

同じレスポンス構造を利用し続けたい場合

現在と同じレスポンスで利用を続けたい場合は、対象のエンドポイントにcnt=0のパラメータを設定してください。

cnt=0を指定した場合のレスポンス例：

{
  "errors": [],
  "messages": [],
  "list": [
    {
      "topics_id": 823,
      "topics_group_id": 61,
      "data_draft_id": 412,
      "lang": "ja",
      "member_id": 22,
      "update_comment": "",
      "prev_data_waiting_id": 0,
      "title": "draft test 1"
    },
    ...
    ...
  ],
  "pageInfo": {
    "totalCnt": 22
  }
}

※pageInfoのレスポンスは追加されます。

注意

cnt=0を設定した場合に、途中保存データが多いと読み込みに時間がかかります。
途中保存が多くなる場合はページネーションなど、pageInfoを利用して分割して取得するように実装してください。

反映予定日

正式版反映：2025年1月中旬

• Kurocoのバージョン管理について

お問い合わせ先

本件についてご不明点がございましたら、Kurocoサポートまでお気軽にお問い合わせください。

• サポート