カスタムAPI呼び出し

このピースでできること

  • freee工数管理のAPIの任意のエンドポイントにカスタムリクエストを送信します。
  • 標準のアクションでは対応していない操作も実行できます。

freee工数管理 の接続方法

workrun と freee工数管理 を接続するには、freee工数管理 の OAuth クライアント(クライアントID・クライアントシークレット) が必要です。

ステップ 1:workrun のリダイレクト URL を確認する

  1. workrun で freee工数管理 のアクション/トリガーをフローに追加します。
  1. 「接続を選択」の横にある 「+ 新しい接続」 をクリックします。
  1. 接続画面に表示される 「リダイレクト URL」 をコピーしておきます。

ステップ 2:freee工数管理 で OAuth クライアントを作成する

  1. freeeアプリストア を開き、アプリケーションを新規登録します。
  1. コールバックURL の欄に、ステップ 1 でコピーした リダイレクト URL を貼り付けます。
  1. 権限設定 で、以下の項目にチェックを入れます。
      • [工数管理] 従業員: 参照(従業員の選択肢取得に使用)
      • [工数管理] チーム: 参照(チームの選択肢取得に使用)
      • [工数管理] プロジェクト: 参照(プロジェクトの選択肢取得に使用)
      • [工数管理] 工数: 参照・更新
      • ※「カスタムAPI呼び出し」アクションを利用する場合は、そのエンドポイントに対応する権限も追加してください
  1. 設定を保存し、クライアントIDクライアントシークレット をコピーします。

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

  1. ステップ 1 の接続画面に戻り、クライアントIDクライアントシークレット をそれぞれ貼り付けます。
  1. 「接続」 をクリックすると、freee の認証画面が開きます。
  1. freee にログインし、workrun に対するアクセスを 「許可」 します。
  1. 画面が自動で閉じ、接続が完了します。

ピースの設定項目

1. URL(必須)

  • リクエスト先のURLを入力してください。完全なURLまたはベースURLからの相対パスのどちらでも指定できます。
    • ベースURL:

2. メソッド(必須)

  • HTTPメソッドを選択してください。
    • GET: データを取得する
    • POST: データを作成する
    • PUT: データを全体更新する
    • PATCH: データを部分更新する
    • DELETE: データを削除する

3. ヘッダー(任意)

  • 追加のHTTPヘッダーを設定します。認証ヘッダー(Authorization)は接続から自動的に注入されます。

4. クエリパラメータ(任意)

  • URLに付加するクエリパラメータをキーと値のペアで入力します。

5. ボディ(任意)

  • POST/PUT/PATCHリクエスト時に送信するリクエストボディをJSON形式で入力してください。

6. 失敗時にエラーにしない(任意)

  • 有効にすると、APIエラー時もフローを停止せずに続行します。エラーを無視して処理を続けたい場合に使用します。