書類一覧を取得する

このピースでできること

  • クラウドサインで、条件を指定して書類の一覧を取得します。
  • ステータスや最終処理日時などで絞り込みながら、書類の確認・集計に利用できます。
 

クラウドサイン の接続方法

以下の2つを入力して接続します。

環境

接続先の環境を選択します。
  • プロダクション — 本番環境(通常はこちらを選択)
  • サンドボックス — テスト・検証用環境

クライアントID

クラウドサインの管理画面から発行したクライアントIDを入力します。
  1. クラウドサイン管理画面にログインします
  1. 「外部連携」 または 「API 連携」 メニューを開きます
  1. クライアントIDを発行し、コピーします
  1. 接続画面の 「クライアントID」 欄に貼り付けます
サンドボックス環境でテストする場合は、サンドボックス用のクライアントIDを別途取得してください。
 

ピースの設定項目

1. ページ番号(任意)

  • 取得するページ番号を指定します。
  • 指定がない場合は、通常は1ページ目が取得されます。

2. ステータス(任意)

  • 書類のステータスで絞り込みたい場合に指定します。
  • すべてのステータスを対象にしたい場合は「すべて」を指定します。

3. ファイル情報を含める(任意)

  • レスポンスにファイル情報を含めるかどうかを指定します。

4. 参加者の情報を含める(任意)

  • レスポンスに参加者情報を含めるかどうかを指定します。

5. 共有先情報を含める(任意)

  • レスポンスに共有先(reportees)の情報を含めるかどうかを指定します。

6. 書類管理者が共有したテンプレートを含める(任意)

  • 書類管理者が共有したテンプレート情報を含めるかどうかを指定します。

7. 添付書類情報を含める(任意)

  • 添付書類(attachment)の情報を含めるかどうかを指定します。

8. 最終処理日時(開始)(任意)

  • 最終処理日時で絞り込む場合に、開始日時を指定します。
  • 入力形式はISO-8601形式(例: )で指定します。

9. 最終処理日時(終了)(任意)

  • 最終処理日時で絞り込む場合に、終了日時を指定します。
  • 入力形式はISO-8601形式(例: )で指定します。