Box · Schema

Workflow (Mini)

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.

Cloud StorageCollaborationContent ManagementDocumentsEnterpriseFile Sharing

Properties

Name Type Description
id string The unique identifier for the workflow
type string `workflow`
name string The name of the workflow
description string The description for a workflow.
is_enabled boolean Specifies if this workflow is enabled
View JSON Schema on GitHub

JSON Schema

box-workflow-mini-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/Workflow--Mini",
  "title": "Workflow (Mini)",
  "type": "object",
  "x-box-resource-id": "workflow--mini",
  "x-box-tag": "workflows",
  "x-box-variants": [
    "mini",
    "standard",
    "full"
  ],
  "x-box-variant": "mini",
  "description": "Box Relay Workflows are objects that represent a named collection of flows.\n\nYou application must be authorized to use the `Manage Box Relay` application\nscope within the developer console in order to use this resource.",
  "properties": {
    "id": {
      "type": "string",
      "description": "The unique identifier for the workflow",
      "example": "11446498"
    },
    "type": {
      "type": "string",
      "description": "`workflow`",
      "example": "workflow",
      "enum": [
        "workflow"
      ]
    },
    "name": {
      "type": "string",
      "example": "New Hire Workflow",
      "description": "The name of the workflow"
    },
    "description": {
      "type": "string",
      "description": "The description for a workflow.",
      "example": "This workflow sets off a new hire approval flow"
    },
    "is_enabled": {
      "type": "boolean",
      "example": true,
      "description": "Specifies if this workflow is enabled"
    }
  }
}