Box Automateの有効化
組織でBox Automateの利用を開始するには、Box管理者がAutomate (およびフローで使用するBox AI Studioなどのアドオン製品) を必要があります。開発者コンソールで特定のスコープや機能が利用できない場合は、Boxサポートまたは担当のアカウントチームに問い合わせて、ユーザー名または使用予定のアプリのコンテキストを伝えてください。手動開始API
Box APIを使用すれば、[手動で開始] ワークフローをプログラムからトリガーできます。| エンドポイント | メソッド | 説明 |
|---|---|---|
| [手動で開始] トリガーを使用するワークフローのリストを表示する | GET | 指定したフォルダに対して [手動で開始] トリガーが設定されているすべてのAutomateワークフローを取得します。ワークフローのリストが返されます。フォルダIDを指定する必要があります。 |
| [手動で開始] ワークフローをトリガーする | POST | 選択したファイルで特定のワークフローをトリガーします。 |
リクエストパラメータ
files- リクエスト本文にファイルIDを指定します (フォルダをトリガーとする場合は省略可、1回のリクエストにつき最大20ファイルまで)fields defined at start- ワークフローで実行時フィールド (タスクの担当者や通知の受信者など) が必要な場合は、APIコールにそれらを含めます。必須フィールドが指定されていない場合、エラーが返されます。
注: ユーザーが自身のコネクタを追加するオプションを管理者が無効にしている場合、ユーザーが選択できるのはドロップダウンメニューにある事前承認済みコネクタのみとなります。
- ワークフロービルダーを開きます。
- カスタムHTTPリクエストの結果を追加します。
- 以下のフィールドに入力します。
- URL: コネクタを選択するか、許可されている場合は新しいコネクタを追加します。
- メソッド: GET、POST、DELETE、PUT、またはPATCHを選択します。
- Query Parameters (クエリパラメータ): 必要なキー/値ペアを追加します。
- 認証: 認証タイプを選択し、必要な情報を入力します。
- Headers (ヘッダー): ヘッダーを追加します (省略可)。
- 本文: JSONリクエストの本文を入力します。
- 説明: リクエストの内容を簡単に記述します。
- OAuth 2.0 Client Credentials (OAuth 2.0クライアント資格情報): クライアントID、クライアントシークレット、承認URL、トークンURL、スコープ
- Basic Auth (Basic認証): ユーザー名とパスワード
- Bearer Token (ベアラートークン): トークン
- APIキー: APIキー
- Custom Header (カスタムヘッダー): ヘッダー名と値
- 結果を構成したら、[テスト] ボタンをクリックします。
- テストのレスポンスコードを確認し、接続が機能していることを確認します。
- ビルダーはレスポンスのプロパティを自動的に取得し、変数を作成します。
- JSONパス (https://jsonpath.com/) を使用して、テストレスポンスの変数を確認します。