> ## Documentation Index
> Fetch the complete documentation index at: https://developer.box.com/llms.txt
> Use this file to discover all available pages before exploring further.

# ワークフロー (リスト) リソース

Box Relayワークフローは、名前が付けられたフローのコレクションを表すオブジェクトです。

## Workflow

Box Relayワークフローは、名前が付けられたフローのコレクションを表すオブジェクトです。 アプリケーションは、このリソースを使用するために、開発者コンソールでの`Manage Box Relay`アプリケーションスコープの使用が承認されている必要があります。

<Accordion title="属性と例">
  | プロパティ         | 型                 | 必須  | 説明                                           |
  | ------------- | ----------------- | --- | -------------------------------------------- |
  | `id`          | `string`          | いいえ | ワークフローの一意の識別子。                               |
  | `type`        | `enum<string>`    | いいえ | 値は常に`workflow`になります。 使用可能なオプション: `workflow`. |
  | `name`        | `string`          | いいえ | ワークフローの名前。                                   |
  | `description` | `string`          | いいえ | ワークフローの説明                                    |
  | `is_enabled`  | `boolean`         | いいえ | このワークフローが有効かどうかを指定します。                       |
  | `flows`       | array of `object` | いいえ | ワークフローに割り当てられているフローのリスト。                     |

  ```json 例 theme={null}
  {
    "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"
        }
      }
    ]
  }
  ```
</Accordion>

## ワークフロー (Mini)

Box Relayワークフローは、名前が付けられたフローのコレクションを表すオブジェクトです。 アプリケーションは、このリソースを使用するために、開発者コンソールでの`Manage Box Relay`アプリケーションスコープの使用が承認されている必要があります。

<Accordion title="属性と例">
  | プロパティ         | 型              | 必須  | 説明                                           |
  | ------------- | -------------- | --- | -------------------------------------------- |
  | `id`          | `string`       | いいえ | ワークフローの一意の識別子。                               |
  | `type`        | `enum<string>` | いいえ | 値は常に`workflow`になります。 使用可能なオプション: `workflow`. |
  | `name`        | `string`       | いいえ | ワークフローの名前。                                   |
  | `description` | `string`       | いいえ | ワークフローの説明                                    |
  | `is_enabled`  | `boolean`      | いいえ | このワークフローが有効かどうかを指定します。                       |

  ```json 例 theme={null}
  {
    "id": "11446498",
    "type": "workflow",
    "name": "New Hire Workflow",
    "description": "This workflow sets off a new hire approval flow",
    "is_enabled": true
  }
  ```
</Accordion>

## ワークフロー (リスト)

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

<Accordion title="属性と例">
  | プロパティ         | 型                              | 必須  | 説明                                                                             |
  | ------------- | ------------------------------ | --- | ------------------------------------------------------------------------------ |
  | `limit`       | `integer`                      | いいえ | これらのエントリで使用された制限値。許容される最大値を超えていない限り、クエリパラメータの`limit`と等しくなります。最大値はAPIによって異なります。 |
  | `next_marker` | `string`                       | いいえ | 次の検索結果ページの開始場所のマーカー。 `null` を指定できます。                                           |
  | `prev_marker` | `string`                       | いいえ | 前の検索結果ページの開始場所のマーカー。 `null` を指定できます。                                           |
  | `entries`     | array of [Workflow](#workflow) | いいえ | ワークフローのリスト。                                                                    |

  ```json 例 theme={null}
  {
    "limit": 1000,
    "next_marker": "JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii",
    "prev_marker": "JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVih",
    "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"
            }
          }
        ]
      }
    ]
  }
  ```
</Accordion>
