Workflow

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

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

This resource has a few variations that can be encountered when using the API.

The fields that are part of the standard variant are generally returned when the resource is requested via its own API endpoints. For example, when retrieving a file by ID, it will return these fields unless the fields parameter has been specified.

string
11446498

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

string
workflow

Value is always workflow

This workflow sets off a new hire approval flow

ワークフローの説明。

object array

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

string
12345

フローのID

flow

Value is always flow

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

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

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

object array

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

12345

結果のID

outcome

Value is always outcome

assign_task

結果の種類

Value is one of 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

Value is always outcome

assign_task

結果の種類

Value is one of 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

Value is always trigger

object array

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

trigger_scope

Value is always trigger_scope

refが指すオブジェクト

/event/source/parameters/folder

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

WORKFLOW_MANUAL_START

Value is always WORKFLOW_MANUAL_START

boolean
true

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

string
New Hire Workflow

ワークフローの名前

Response Example

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