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.

This resource has a few variations that can be encountered when using the API.

The fields that are part of the full variant can be returned by API endpoints that support the fields parameter. For example, by defining the fields request parameter as id,type when requesting a file by ID, only those fields will be returned in the API response.

id string

example"11446498"

The unique identifier for the workflow

type string

example"workflow"

workflow

Value is always workflow

created_at string / date-time

example"2012-12-12T10:53:43-08:00"

The date and time when the workflow was created on Box

created_byUser (Base) object

The user who created this workflow

description string

example"This workflow sets off a new hire approval flow"

The description for a workflow.

flows object array

A list of flows assigned to a workflow.

[flows].id string

example"12345"

The identifier of the flow

[flows].type string

example"flow"

The flow's resource type

Value is always flow

[flows].created_at string / date-time

example"2012-12-12T10:53:43-08:00"

When this flow was created

[flows].created_byUser (Base) object

The user who created this flow

[flows].outcomes object array

Actions that are completed once the flow is triggered

[outcomes].id string

example"12345"

The identifier of the outcome

[outcomes].type string

example"outcome"

The outcomes resource type

Value is always outcome

[outcomes].action_type string

example"assign_task"

The 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

[outcomes].if_rejected object array

If action_type is assign_task and the task is rejected, returns a list of outcomes to complete

[if_rejected].id string

example"12345"

The identifier of the outcome

[if_rejected].type string

example"outcome"

The outcomes resource type

Value is always outcome

[if_rejected].action_type string

example"assign_task"

The type of outcome

[if_rejected].name string

example"Approval Rejection Outcome"

The name of the outcome

[outcomes].name string

example"Task Approval Outcome"

The name of the outcome

[flows].trigger object

Trigger that initiates flow

trigger.type string

example"trigger"

The trigger's resource type

Value is always trigger

trigger.scope object array

List of trigger scopes

[scope].type string

example"trigger_scope"

The trigger scope's resource type

Value is always trigger_scope

[scope].object object

The object the ref points to

[scope].ref string

example"/event/source/parameters/folder"

Indicates the path of the condition value to check

trigger.trigger_type string

example"WORKFLOW_MANUAL_START"

The type of trigger selected for this flow

Value is always WORKFLOW_MANUAL_START

is_enabled boolean

exampletrue

Specifies if this workflow is enabled

modified_at string / date-time

example"2012-12-12T10:53:43-08:00"

The date and time when the workflow was last updated on Box

modified_byUser (Base) object

The user who last modified this workflow

name string

example"New Hire Workflow"

The 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"
}