APIバージョン 2024.0
Box Relayワークフローは、名前が付けられたフローのコレクションを表すオブジェクトです。
アプリケーションは、このリソースを使用するために、開発者コンソールでのManage Box Relayアプリケーションスコープの使用が承認されている必要があります。
このリソースにはAPIの使用時に発生する可能性があるいくつかのバリエーションがあります。通常、Standardバリアントに含まれるフィールドは、固有のAPIエンドポイントを介してこのリソースがリクエストされたときに返されます。
たとえば、fieldsパラメータが指定されていない場合、IDでファイルを取得すると、これらのフィールドが返されます。
例 workflow値は常にworkflowになります。次の値に固定: workflow
例 This workflow sets off a new hire approval flowワークフローの説明
ワークフローに割り当てられているフローのリスト。
例 flowフローのリソースの種類。次の値に固定: flow
例 2012-12-12T10:53:43-08:00このフローが作成された日時。
フローがトリガーされたら完了する操作。
例 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_typeがassign_taskの場合にタスクが拒否されると、完了すべき結果のリストが返されます。
例 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
トリガースコープのリスト。
例 trigger_scopeトリガースコープのリソースの種類。次の値に固定: trigger_scope
例 /event/source/parameters/folder確認する条件値のパスを示します。
例 WORKFLOW_MANUAL_STARTこのフローに選択されているトリガーのタイプ。次の値に固定: WORKFLOW_MANUAL_START
例 trueこのワークフローが有効かどうかを指定します。
例 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"
}
