契約書一覧を取得する

このピースでできること

  • ContractS CLMの契約書一覧を、担当者・チャネル・ステータスなどの条件で絞り込んで取得します。
  • 取得件数やページ番号を指定して、大量の契約書データをページ単位で取得することができます。

ContractS CLM の接続方法

workrun と ContractS CLM を接続するには、ContractS CLM の API キー が必要です。

ステップ 1:API キーを取得する

  1. ContractS CLM に管理者権限のユーザーでログインします。
  1. 画面右上のアカウントメニューから 「会社設定」 を開きます。
  1. 「API機能」 欄に表示される API キーをコピーします。
      • API キーが未発行の場合は、ContractS 社の担当者へ利用申し込みが必要です。

ステップ 2:workrun に接続を追加する

  1. workrun で ContractS CLM のアクションをフローに追加します。
  1. 「接続を選択」の横にある 「+ 新しい接続」 をクリックします。
  1. 「APIキー」 フィールドに、ステップ 1 でコピーした API キーを貼り付けます。
  1. 「環境」 で接続先を選択します(通常は「本番環境(Production)」を選択してください)。
  1. 「保存」 をクリックして接続を完了します。

ピースの設定項目

1. アカウント名(任意)

  • 契約書を担当しているユーザーのアカウント名を選択します。選択肢はContractS CLMに登録されているユーザー一覧から自動的に表示されます(最大300件)。未選択の場合は全担当者の契約書が対象になります。

2. チャネル名(任意)

  • 契約書が属するチャネル名を選択します。選択肢はContractS CLMのチャネル一覧から自動的に表示されます(最大300件)。未選択の場合は全チャネルの契約書が対象になります。

3. 外部キー(任意)

  • CSV取り込みやAPIで付与した外部キーを入力して、その外部キーが設定された契約書だけに絞り込みます。

4. 検索文字列(任意)

  • 契約書のタイトル・タグ・外部キーに対してキーワード検索を行います。入力した文字列を含む契約書が取得されます。

5. 契約締結状態(任意)

  • 取得する契約書のステータスを選択します。未選択の場合はすべてのステータスの契約書を取得します。
    • 未締結
    • 相手方返答待ち
    • 締結済み
    • 差戻し
    • 契約満了

6. 取得件数(任意)

  • 1回のリクエストで取得する契約書の最大件数を入力します。最大100まで指定できます。

7. ページ番号(任意)

  • 取得するページ番号を指定します。1ページ目から始まります(既定値: 1)。取得件数と組み合わせてページング取得ができます。