トリガータイプがWORKFLOW_MANUAL_START
のフローを開始します。
アプリケーションは、開発者コンソールでのManage Box Relay
アプリケーションスコープの使用が承認されている必要があります。
"12345"
ワークフローのID。
"workflow_parameters"
パラメータオブジェクトのタイプ
次の値に固定: workflow_parameters
ワークフローが開始されるファイルの配列。すべてのファイルは、ワークフローの設定済みフォルダに存在する必要があります。
"12345678"
ファイルのID
"file"
ファイルオブジェクトのタイプ
次の値に固定: file
トリガーされるフロー
"123456789"
フローのID
"flow"
フローオブジェクトのタイプ
ワークフローが設定されているフォルダオブジェクト。
"87654321"
フォルダのID
"folder"
フォルダオブジェクトのタイプ
次の値に固定: folder
開始時に設定する必要がある結果のリスト。
"890375782"
結果のID
"outcome"
結果オブジェクトのタイプ
次の値に固定: outcome
"placeholder"
これは、渡すことができるさまざまなオブジェクトを表すプレースホルダの例です。詳細については、ガイドセクションを参照してください。
ワークフローを開始します。
パラメータが不足しているか無効の場合はエラーを返します。
workflow_is_not_enabled
workflow_not_active_on_provided_folder
parameters_provided_do_not_match_target_outcome
権限が不足している場合にエラーを返します。
insufficient_access
missing_relay_full_access
ワークフローが見つからない場合、または認証済みユーザーがワークフローにアクセスできない場合はエラーを返します。
workflow_not_found
flow_missing_or_inaccessible
予期しないクライアントエラー。
curl -i -X POST "https://api.box.com/2.0/workflows/42037322/start" \
-H "Authorization: Bearer <ACCESS_TOKEN>" \
-d '{
"type": "workflow_parameters",
"flow": {
"id": "8937625",
"type": "flow"
},
"files": [{
"type": "file",
"id": "389047572"
},
{
"type": "file",
"id": "389047578"
}],
"folder": {
"id": "2233212",
"type": "folder"
},
"outcomes": [
{
"id": "34895783",
"type": "outcome",
"task_collaborators": {
"type": "variable",
"variable_type": "user_list",
"variable_value": [{ "type": "user", "id": "890273642" }]
},
"completion_rule": {
"type": "variable",
"variable_type": "task_completion_rule",
"variable_value": "all_assignees"
},
"file_collaborator_role": {
"type": "variable",
"variable_type": "collaborator_role",
"variable_value": "viewer"
}
}
]
}'