Webex · Schema

FlowRes

CallingCollaborationCommunicationEnterpriseMessagingVideo Conferencing

Properties

Name	Type	Description
assignedRS	array	Assigned Routing Strategy.
createdBy	string	Email of the account which created the flow.
createdDate	string	Date of creation of the flow.
draftVersion	object
flowType	string	Either of 'FLOW' or 'SUBFLOW.
flowVersions	array	Published FlowVersions for this flow.
id	string	Flow ID
lastModifiedBy	string	Email of the account which modified the flow last.
lastModifiedDate	string	Date the flow object is last modified.
latestVersion	object
lockedAt	string	Moment at which a user began editing the flow and locked the flow for everyone else.
lockedBy	string	Email of the account which is currently editing the flow.
orgId	string	Organization ID.
preferences	array	Flow preferences
projectId	string	Project ID. System generated value which is the same across orgs and environments. Always use: 5e5c9ad6d61f870d6d778c1b
status	string	Indicates if this flow has ever been published - is one of 'Draft' or 'Published'.
tagHistories	object	Histories of the tags. Tracks how the tags have been assigned to versions chronologically
tags	array	Flow tags
validating	boolean	Determines whether the version object needs to be validated.
version	integer	Version Number.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/FlowRes",
  "title": "FlowRes",
  "type": "object",
  "properties": {
    "assignedRS": {
      "uniqueItems": true,
      "type": "array",
      "description": "Assigned Routing Strategy.",
      "example": [
        "RS1",
        "RS2"
      ],
      "items": {
        "type": "string"
      }
    },
    "createdBy": {
      "type": "string",
      "description": "Email of the account which created the flow.",
      "example": "[email protected]"
    },
    "createdDate": {
      "type": "string",
      "description": "Date of creation of the flow.",
      "format": "date-time",
      "example": "2024-02-07T14:10:50.663Z"
    },
    "draftVersion": {
      "$ref": "#/components/schemas/FlowVersionRes"
    },
    "flowType": {
      "type": "string",
      "description": "Either of 'FLOW' or 'SUBFLOW.",
      "example": "FLOW"
    },
    "flowVersions": {
      "type": "array",
      "description": "Published FlowVersions for this flow.",
      "example": [
        "65c28d9db2a2375974066579",
        "75974065c28d9db3665792a2"
      ],
      "items": {
        "type": "string",
        "description": "Flow Version object ID to with which the tag is currently associated.",
        "example": "65c28d9db2a2375974066579"
      }
    },
    "id": {
      "type": "string",
      "description": "Flow ID",
      "example": "65c28d9db2a2375974066579"
    },
    "lastModifiedBy": {
      "type": "string",
      "description": "Email of the account which modified the flow last.",
      "example": "[email protected]"
    },
    "lastModifiedDate": {
      "type": "string",
      "description": "Date the flow object is last modified.",
      "example": "2024-02-07T14:10:50.663Z",
      "format": "date-time"
    },
    "latestVersion": {
      "$ref": "#/components/schemas/FlowVersionRes"
    },
    "lockedAt": {
      "type": "string",
      "description": "Moment at which a user began editing the flow and locked the flow for everyone else.",
      "format": "date-time",
      "example": "2024-02-07T14:10:50.663Z"
    },
    "lockedBy": {
      "type": "string",
      "description": "Email of the account which is currently editing the flow.",
      "example": "[email protected]"
    },
    "orgId": {
      "type": "string",
      "description": "Organization ID.",
      "example": "8eb7da9a-c81c-4d13-b08b-38fdeb7330d8"
    },
    "preferences": {
      "type": "array",
      "description": "Flow preferences",
      "items": {
        "$ref": "#/components/schemas/FlowPreferenceRes"
      }
    },
    "projectId": {
      "type": "string",
      "description": "Project ID. System generated value which is the same across orgs and environments. Always use: 5e5c9ad6d61f870d6d778c1b",
      "example": "5e5c9ad6d61f870d6d778c1b"
    },
    "status": {
      "type": "string",
      "description": "Indicates if this flow has ever been published - is one of 'Draft' or 'Published'.",
      "example": "Draft"
    },
    "tagHistories": {
      "type": "object",
      "description": "Histories of the tags. Tracks how the tags have been assigned to versions chronologically",
      "additionalProperties": {
        "type": "array",
        "items": {
          "$ref": "#/components/schemas/FlowProgressionRes"
        }
      },
      "example": {
        "Latest": [
          {
            "fvId": "63e3fcb0b57f601a2ad62db4",
            "fvName": "HttpTraceTest",
            "forkFrom": "63e3fcb0b57f601a2ad62db4"
          }
        ]
      }
    },
    "tags": {
      "type": "array",
      "description": "Flow tags",
      "items": {
        "$ref": "#/components/schemas/FlowTagRes"
      }
    },
    "validating": {
      "type": "boolean",
      "description": "Determines whether the version object needs to be validated.",
      "example": false
    },
    "version": {
      "type": "integer",
      "description": "Version Number.",
      "format": "int32",
      "example": 1
    }
  }
}