メインコンテンツにスキップ
2021年10月 Web API アップデート 変更点
クラウドサイン運営事務局 avatar
対応者:クラウドサイン運営事務局
3年以上前に更新

2021年10月にリリースされたWeb APIアップデートの変更点についてご説明いたします。

主な変更点

  • 対象API

    • GET /documents および GET /team_documents

  • 追加パラメータ

    • from: 絞り込み開始日時(RFC3339準拠)

      • from=YYYY-MM-DDThh:mm:ss.SSSSSSZ

    • to: 絞り込み終了日時(RFC3339準拠)

      • to=YYYY-MM-DDThh:mm:ss.SSSSSSZ

  • それぞれ指定した値を含む

    • document.last_processed_at >= from

    • document.last_processed_対at <= to

例)日本時間で10月27日0時以降に更新があった締結済の書類を取得

したい場合、以下のパラメータを指定する

GET /documents?from=2021-10-26T15:00:00.000000Z&status=2

注意事項

ご利用いただく場合は以下の点にご注意の上、ご利用ください。

  • 追加されるパラメータが「日付」を含むフォーマットに変更となります

  • 書類のステータス(締結済み/却下/先方確認中など)によって、レスポンスが変わります

  • 不正なパラメータの場合、以下のエラーとなります

    • Invalid value for from:不正な日付のフォーマットがfromに指定された場合

    • Invalid value for to:不正な日付のフォーマットがtoに指定された場合

参考記事

こちらの回答で解決しましたか?