Join BoxWorks 2024 to discover what's possible with content and AI!
Register now!Workflow (Full)
Box Relay Workflows are objects that represent a named collection of flows.
You application must be authorized to use the Manage Box Relay application
scope within the developer console in order to use this resource.
11446498The unique identifier for the workflow
workflowworkflow
Value is always workflow
2012-12-12T10:53:43-08:00The date and time when the workflow was created on Box
The user who created this workflow
This workflow sets off a new hire approval flowThe description for a workflow.
A list of flows assigned to a workflow.
12345The identifier of the flow
flowThe flow's resource type
Value is always flow
2012-12-12T10:53:43-08:00When this flow was created
The user who created this flow
Actions that are completed once the flow is triggered
12345The identifier of the outcome
outcomeThe outcomes resource type
Value is always outcome
assign_taskThe type of outcome
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
If action_type is assign_task and the task is rejected, returns a
list of outcomes to complete
12345The identifier of the outcome
outcomeThe outcomes resource type
Value is always outcome
assign_taskThe type of outcome
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 OutcomeThe name of the outcome
Task Approval OutcomeThe name of the outcome
Trigger that initiates flow
triggerThe trigger's resource type
Value is always trigger
List of trigger scopes
trigger_scopeThe trigger scope's resource type
Value is always trigger_scope
The object the ref points to
/event/source/parameters/folderIndicates the path of the condition value to check
WORKFLOW_MANUAL_STARTThe type of trigger selected for this flow
Value is always WORKFLOW_MANUAL_START
trueSpecifies if this workflow is enabled
2012-12-12T10:53:43-08:00The date and time when the workflow was last updated on Box
The user who last modified this workflow
New Hire WorkflowThe name of the workflow
Response Example
{
"id": "11446498",
"type": "workflow",
"created_at": "2012-12-12T10:53:43-08:00",
"created_by": {
"id": "11446498",
"type": "user"
},
"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,
"modified_at": "2012-12-12T10:53:43-08:00",
"modified_by": {
"id": "11446498",
"type": "user"
},
"name": "New Hire Workflow"
}