Box Developerドキュメント

ワークフロー (Full)

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

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

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

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

Fullバリアントに含まれるフィールドは、fieldsパラメータをサポートするAPIエンドポイントによって返すことができます。たとえば、IDでファイルを取得するときに、fieldsリクエストパラメータをid,typeに設定すると、これらのフィールドのみがAPIレスポンスで返されます。

string
11446498

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

string
workflow

値は常にworkflowになります。

次の値に固定: workflow

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

Boxでこのワークフローが作成された日時。

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

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 (date-time)
2012-12-12T10:53:43-08:00

Boxでこのワークフローが最後に更新された日時。

このワークフローを最後に変更したユーザー。

string
New Hire Workflow

ワークフローの名前。