レコードを一覧取得する

このピースでできること

  • 楽楽販売の指定したデータベース(DB)のレコードを一覧取得します。
  • 絞込み設定やレコード一覧画面設定を指定して、取得対象を絞り込むことができます。
  • 取得件数や開始位置を指定して、ページング取得ができます。

楽楽販売 の接続方法

workrun と楽楽販売を接続するには、楽楽販売の APIトークン および ドメイン・アカウント情報 が必要です。

ステップ 1:接続に必要な情報を準備する

  1. 楽楽販売で 「API連携オプション」 を契約します。
  1. 楽楽販売の管理者設定で、workrun のサーバーIPアドレスをIPアクセス制限に登録します。
      • 「管理者設定 > セキュリティ設定タブ > IPアクセス制限に関する設定」を開きます。
  1. APIトークンを発行します。
      • 「管理者設定 > ユーザ設定タブ > ユーザ管理 > 設定」でユーザー設定画面を開きます。
      • APIトークン欄の 「生成」 をクリックし、続けて 「確定」 ボタンをクリックします。
      • ⚠️「生成」しただけで「確定」を押していないトークンは無効です。必ず「確定」まで行ってください。
  1. 楽楽販売のURLからドメインとアカウントを確認します。
      • 例: の場合
        • ドメイン:
        • アカウント:

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

  1. workrun で楽楽販売のアクションをフローに追加します。
  1. 「接続を選択」の横にある 「+ 新しい接続」 をクリックします。
  1. 以下の3項目を入力します:
      • 「ドメイン」: ステップ 1 で確認したドメイン(例:
      • 「アカウント」: ステップ 1 で確認したアカウント(例:
      • 「APIトークン」: ステップ 1 で発行したAPIトークン
  1. 「保存」 をクリックします。入力した情報で楽楽販売への接続テストが自動で実行され、成功すると接続が完了します。

ピースの設定項目

1. DBスキーマID(必須)

  • 取得元データベースのIDを入力します。
  • 楽楽販売の「管理者設定 > メンテナンス機能 > APIパラメータ情報」でAPIのプルダウンから「CSVエクスポートAPI」を選び、DBグループと対象データベースを選ぶと確認できます。

2. 絞込みID(任意)

  • 絞込み設定のIDを入力します。指定しない場合は全件が対象になります。
  • 「管理者設定 > メンテナンス機能 > APIパラメータ情報」でAPIのプルダウンから「CSVエクスポートAPI」を選び、DBグループと対象データベースを選ぶと確認できます。
  • 事前にデータベースの「管理 > 対象DBの設定 > 表示設定タブ > 絞込み設定」で絞込み設定を作成する必要があります。

3. レコード一覧画面設定ID(任意)

  • レコード一覧画面設定のIDを入力します。指定しない場合はすべての項目が対象になります。
  • 「管理者設定 > メンテナンス機能 > APIパラメータ情報」で「CSVエクスポートAPI」と対象データベースを選ぶと確認できます。
  • 事前に「DB設定 > 表示設定タブ > レコード一覧画面設定」で設定を作成する必要があります。

4. 取得件数(任意)

  • 取得するレコード数を入力します。デフォルトは10件、最大200件です。
  • 親レコードの件数がカウントされるため、明細行が複数ある場合は指定した件数より多くレコードが取得される場合があります。

5. 取得開始位置(任意)

  • 取得を開始する位置を入力します。デフォルトは1件目(先頭)からです。2ページ目以降を取得したい場合に使用します。