Box Developerドキュメント
 

    Workflow

    このリソースは、バージョン2024.0のエンドポイントで使用されています。 詳細については、 **Box APIのバージョン管理**を参照してください。

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

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

    このリソースにはAPIの使用時に発生する可能性があるいくつかのバリエーションがあります。

    通常、Standardバリアントに含まれるフィールドは、固有のAPIエンドポイントを介してこのリソースがリクエストされたときに返されます。 たとえば、fieldsパラメータが指定されていない場合、IDでファイルを取得すると、これらのフィールドが返されます。

    string
    11446498

    ワークフローの一意の識別子

    string
    workflow

    workflow

    次の値に固定: workflow

    This workflow sets off a new hire approval flow

    ワークフローの説明

    object array

    ワークフローに割り当てられているフローのリスト。

    string
    12345

    フローのID

    flow

    フローのリソースの種類

    次の値に固定: flow

    string (date-time)
    2012-12-12T10:53:43-08:00

    このフローが作成された日時

    このフローを作成したユーザー

    object array

    フローがトリガーされたら完了する操作

    12345

    結果のID

    outcome

    結果のリソースの種類

    次の値に固定: outcome

    assign_task

    結果の種類

    次の値のいずれか1つ: add_metadata,assign_task,copy_file,copy_folder,create_folder,delete_file,delete_folder,lock_file,move_file,move_folder,remove_watermark_file,rename_folder,restore_folder,share_file,share_folder,unlock_file,upload_file,wait_for_task,watermark_file,go_back_to_step,apply_file_classification,apply_folder_classification,send_notification

    action_typeassign_taskの場合にタスクが拒否されると、完了すべき結果のリストが返されます

    12345

    結果のID

    outcome

    結果のリソースの種類

    次の値に固定: outcome

    assign_task

    結果の種類

    次の値のいずれか1つ: add_metadata,assign_task,copy_file,copy_folder,create_folder,delete_file,delete_folder,lock_file,move_file,move_folder,remove_watermark_file,rename_folder,restore_folder,share_file,share_folder,unlock_file,upload_file,wait_for_task,watermark_file,go_back_to_step,apply_file_classification,apply_folder_classification,send_notification

    Approval Rejection Outcome

    結果の名前

    Task Approval Outcome

    結果の名前

    フローを開始するトリガー

    trigger

    トリガーのリソースの種類

    次の値に固定: trigger

    object array

    トリガースコープのリスト

    trigger_scope

    トリガースコープのリソースの種類

    次の値に固定: trigger_scope

    refが指すオブジェクト

    /event/source/parameters/folder

    確認する条件値のパスを示します

    WORKFLOW_MANUAL_START

    このフローに選択されているトリガーのタイプ

    次の値に固定: WORKFLOW_MANUAL_START

    boolean
    true

    このワークフローが有効かどうかを指定します

    string
    New Hire Workflow

    ワークフローの名前

    レスポンスの例

    {
      "id": "11446498",
      "type": "workflow",
      "description": "This workflow sets off a new hire approval flow",
      "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"
        }
      ],
      "is_enabled": true,
      "name": "New Hire Workflow"
    }