Box Developerドキュメント
 
    最新バージョン

    ワークフローのリストを取得

    get
    https://api.box.com/2.0
    /workflows

    このエンドポイントはバージョン2024.0です。引き続き使用するために 変更は必要ありません。詳細については、 **Box APIのバージョン管理**を参照してください。

    指定したfolder IDに作用し、トリガータイプがWORKFLOW_MANUAL_STARTのフローを含むワークフローのリストを返します。

    アプリケーションは、このエンドポイントを使用するために、開発者コンソールでのManage Box Relayアプリケーションスコープの使用が承認されている必要があります。

    リクエスト

    bearer [ACCESS_TOKEN]
    application/json

    クエリパラメータ

    stringクエリ内必須
    12345

    フォルダを表す一意の識別子。

    フォルダIDを確認するには、ウェブアプリケーションでこのフォルダにアクセスして、URLからIDをコピーします。たとえば、URLがhttps://*.app.box.com/folder/123の場合、folder_id123です。

    Boxアカウントのルートフォルダは常にID 0で表されます。

    integer (int64)クエリ内省略可能
    1000
    1000

    返す項目の1ページあたりの最大数。

    stringクエリ内省略可能
    JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii

    結果が返される開始位置のマーカー。マーカーベースのページ割りを使用している場合に使用されます。

    これを使用するには、usemarkertrueに設定する必要があります。

    stringクエリ内省略可能
    WORKFLOW_MANUAL_START

    検索するトリガーのタイプ。

    レスポンス

    ワークフローを返します。

    トリガータイプがWORKFLOW_MANUAL_STARTではない場合に返されます。

    フォルダが見つからない場合、またはユーザーにフォルダへのアクセス権限が与えられていない場合に返されます。

    予期しないクライアントエラー。

    get
    ワークフローのリストを取得
    このドキュメント内で一部のAPIを試せるようになりました。
    ログイン

    リクエストの例

    cURL
    curl -i -X GET "https://api.box.com/2.0/workflows?folder_id=324234" \
         -H "authorization: Bearer <ACCESS_TOKEN>"

    レスポンスの例

    {
      "entries": [
        {
          "description": "This workflow sets off a new hire approval flow",
          "id": "11446498",
          "is_enabled": true,
          "name": "New Hire Workflow",
          "type": "workflow",
          "flows": [
            {
              "created_at": "2012-12-12T10:53:43-08:00",
              "created_by": {
                "id": "11446498",
                "type": "user"
              },
              "id": "12345",
              "outcomes": [
                {
                  "action_type": "assign_task",
                  "id": "12345",
                  "if_rejected": [
                    {
                      "action_type": "assign_task",
                      "id": "12345",
                      "name": "Approval Rejection Outcome",
                      "type": "outcome"
                    }
                  ],
                  "name": "Task Approval Outcome",
                  "type": "outcome"
                }
              ],
              "trigger": {
                "scope": [
                  {
                    "object": {
                      "id": "12345",
                      "type": "folder"
                    },
                    "ref": "/event/source/parameters/folder",
                    "type": "trigger_scope"
                  }
                ],
                "trigger_type": "WORKFLOW_MANUAL_START",
                "type": "trigger"
              },
              "type": "flow"
            }
          ]
        }
      ],
      "limit": 1000,
      "next_marker": "JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii",
      "prev_marker": "JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVih"
    }