Box · Schema

Workflows

A list of workflows. 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
View JSON Schema on GitHub

JSON Schema

box-workflows-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/Workflows",
  "title": "Workflows",
  "type": "object",
  "x-box-resource-id": "workflows",
  "x-box-tag": "workflows",
  "description": "A list of workflows.\n\nYou application must be authorized to use the `Manage Box Relay` application\nscope within the developer console in order to use this resource.",
  "allOf": [
    {
      "type": "object",
      "description": "The part of an API response that describes marker\nbased pagination",
      "properties": {
        "limit": {
          "description": "The limit that was used for these entries. This will be the same as the\n`limit` query parameter unless that value exceeded the maximum value\nallowed. The maximum value varies by API.",
          "example": 1000,
          "type": "integer",
          "format": "int64"
        },
        "next_marker": {
          "description": "The marker for the start of the next page of results.",
          "example": "JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii",
          "type": "string",
          "nullable": true
        },
        "prev_marker": {
          "description": "The marker for the start of the previous page of results.",
          "example": "JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVih",
          "type": "string",
          "nullable": true
        }
      }
    },
    {
      "properties": {
        "entries": {
          "type": "array",
          "description": "A list of workflows",
          "items": {
            "$ref": "#/components/schemas/Workflow"
          }
        }
      }
    }
  ]
}