トリガータイプがWORKFLOW_MANUAL_STARTのフローを開始します。
アプリケーションは、開発者コンソールでのManage Box Relayアプリケーションスコープの使用が承認されている必要があります。
12345ワークフローのID。
"workflow_parameters"パラメータオブジェクトのタイプ。
次の値に固定: workflow_parameters
ワークフローが開始されるファイルの配列。すべてのファイルは、ワークフローの設定済みフォルダに存在する必要があります。
"12345678"ファイルのID。
"file"ファイルオブジェクトのタイプ。
次の値に固定: file
トリガーされるフロー。
"123456789"フローのID。
"flow"フローオブジェクトのタイプ。
ワークフローが設定されているフォルダオブジェクト。
"87654321"フォルダのID。
"folder"フォルダオブジェクトのタイプ。
次の値に固定: folder
ワークフローで完了する必要がある設定可能な結果。
"17363629"特定の結果のID。
ワークフローの結果の影響を受けたコラボレータのリストを取得します。
"variable"コラボレータオブジェクトタイプ。
次の値に固定: variable
"user_list"コラボレータオブジェクトの変数タイプ。
次の値に固定: user_list
ユーザーIDのリスト。
"636281"ユーザーのID。
"user"オブジェクトタイプ。
次の値に固定: user
操作をすべての担当者が完了する必要があるか、一人でも完了すればよいかを決定します。
"variable"完了ルールオブジェクトタイプ。
次の値に固定: variable
"task_completion_rule"完了ルールオブジェクトの変数タイプ。
次の値に固定: task_completion_rule
"all_assignees"完了ルールの変数値。
次の値のいずれか1つ: all_assignees,any_assignees
特定のコラボレータの役割がファイルに関するワークフローの結果の影響を受けるかどうかを決定します。
"variable"役割オブジェクトタイプ。
次の値に固定: variable
"collaborator_role"オブジェクトで使用される変数タイプ。
次の値に固定: collaborator_role
"editor"役割パラメータに使用できる変数値。
次の値のいずれか1つ: editor,viewer,previewer,uploader,previewer uploader,viewer uploader,co-owner
特定のコラボレータの役割がワークフローの結果の影響を受けるかどうかを決定します。
"variable"役割オブジェクト タイプ。
次の値に固定: variable
"collaborator_role"オブジェクトで使用される変数タイプ。
次の値に固定: collaborator_role
"editor"役割パラメータに使用できる変数値。
次の値のいずれか1つ: editor,viewer,previewer,uploader,previewer uploader,viewer uploader,co-owner
タスクのワークフローの結果の影響を受けたコラボレータのリストを取得します。
"variable"コラボレータオブジェクトタイプ。
次の値に固定: variable
"user_list"コラボレータオブジェクトの変数タイプ。
次の値に固定: user_list
ユーザーIDのリスト。
"636281"ユーザーのID。
"user"オブジェクトタイプ。
次の値に固定: user
ワークフローを開始します。
パラメータが不足しているか無効の場合はエラーを返します。
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"
}
}
]
}'await adminClient.workflows.startWorkflow(workflowToRun.id!, {
type: 'workflow_parameters' as StartWorkflowRequestBodyTypeField,
flow: {
type: 'flow',
id: workflowToRun.flows![0].id!,
} satisfies StartWorkflowRequestBodyFlowField,
files: [
{
type: 'file' as StartWorkflowRequestBodyFilesTypeField,
id: workflowFileId,
} satisfies StartWorkflowRequestBodyFilesField,
],
folder: {
type: 'folder' as StartWorkflowRequestBodyFolderTypeField,
id: workflowFolderId,
} satisfies StartWorkflowRequestBodyFolderField,
} satisfies StartWorkflowRequestBody);admin_client.workflows.start_workflow(
workflow_to_run.id,
StartWorkflowFlow(type="flow", id=workflow_to_run.flows[0].id),
[StartWorkflowFiles(type=StartWorkflowFilesTypeField.FILE, id=workflow_file_id)],
StartWorkflowFolder(
type=StartWorkflowFolderTypeField.FOLDER, id=workflow_folder_id
),
type=StartWorkflowType.WORKFLOW_PARAMETERS,
)await adminClient.Workflows.StartWorkflowAsync(workflowId: NullableUtils.Unwrap(workflowToRun.Id), requestBody: new StartWorkflowRequestBody(flow: new StartWorkflowRequestBodyFlowField() { Type = "flow", Id = NullableUtils.Unwrap(NullableUtils.Unwrap(workflowToRun.Flows)[0].Id) }, files: Array.AsReadOnly(new [] {new StartWorkflowRequestBodyFilesField() { Type = StartWorkflowRequestBodyFilesTypeField.File, Id = workflowFileId }}), folder: new StartWorkflowRequestBodyFolderField() { Type = StartWorkflowRequestBodyFolderTypeField.Folder, Id = workflowFolderId }) { Type = StartWorkflowRequestBodyTypeField.WorkflowParameters });try await adminClient.workflows.startWorkflow(workflowId: workflowToRun.id!, requestBody: StartWorkflowRequestBody(type: StartWorkflowRequestBodyTypeField.workflowParameters, flow: StartWorkflowRequestBodyFlowField(type: "flow", id: workflowToRun.flows![0].id!), files: [StartWorkflowRequestBodyFilesField(type: StartWorkflowRequestBodyFilesTypeField.file, id: workflowFileId)], folder: StartWorkflowRequestBodyFolderField(type: StartWorkflowRequestBodyFolderTypeField.folder, id: workflowFolderId)))adminClient.getWorkflows().startWorkflow(workflowToRun.getId(), new StartWorkflowRequestBody.Builder(new StartWorkflowRequestBodyFlowField.Builder().type("flow").id(workflowToRun.getFlows().get(0).getId()).build(), Arrays.asList(new StartWorkflowRequestBodyFilesField.Builder().type(StartWorkflowRequestBodyFilesTypeField.FILE).id(workflowFileId).build()), new StartWorkflowRequestBodyFolderField.Builder().type(StartWorkflowRequestBodyFolderTypeField.FOLDER).id(workflowFolderId).build()).type(StartWorkflowRequestBodyTypeField.WORKFLOW_PARAMETERS).build())