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

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

指定した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クエリ内省略可能
10001000

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

stringクエリ内省略可能
JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii

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

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

stringクエリ内省略可能
WORKFLOW_MANUAL_START

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

レスポンス

application/jsonWorkflows

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

トリガータイプが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": [
    {
      "id": 11446498,
      "type": "workflow",
      "name": "New Hire Workflow",
      "description": "This workflow sets off a new hire approval flow",
      "is_enabled": true,
      "flows": [
        {
          "id": 12345,
          "type": "flow",
          "trigger": {
            "type": "trigger",
            "trigger_type": "WORKFLOW_MANUAL_START",
            "scope": [
              {
                "type": "trigger_scope",
                "ref": "/event/source/parameters/folder",
                "object": {
                  "type": "folder",
                  "id": 12345
                }
              }
            ]
          },
          "outcomes": [
            {
              "id": 12345,
              "type": "outcome",
              "name": "Task Approval Outcome",
              "action_type": "assign_task",
              "if_rejected": [
                {
                  "id": 12345,
                  "type": "outcome",
                  "name": "Approval Rejection Outcome",
                  "action_type": "assign_task"
                }
              ]
            }
          ],
          "created_at": "2012-12-12T10:53:43-08:00",
          "created_by": {
            "id": 11446498,
            "type": "user"
          }
        }
      ]
    }
  ],
  "limit": 1000,
  "next_marker": 3000,
  "prev_marker": 1000
}