Evo Voice

GetFlow

Get the specified flow

**Requires Authentication**
Requires any of the roles:	SystemAdministrator, Manager, Customer

The following routes are available for this service:
GET	/flows/{flowId}

import java.math.*
import java.util.*
import java.io.InputStream
import net.servicestack.client.*
import com.google.gson.annotations.*
import com.google.gson.reflect.*


/**
* Get the specified flow
*/
@Api(Description="Get the specified flow")
open class GetFlow : IGet
{
    /**
    * the ID of the flow to retrieve
    */
    @ApiMember(Description="the ID of the flow to retrieve")
    open var flowId:String? = null
}

open class FlowInfo : EntityInfo()
{
    /**
    * The name of this flow
    */
    @ApiMember(Description="The name of this flow")
    open var name:String? = null

    /**
    * The roles that this flow has
    */
    @ApiMember(Description="The roles that this flow has")
    open var roles:ArrayList<FlowRoles>? = null

    /**
    * What this flow does
    */
    @ApiMember(Description="What this flow does")
    open var description:String? = null

    /**
    * Any notes for this flow
    */
    @ApiMember(Description="Any notes for this flow")
    open var notes:String? = null

    /**
    * The ID of the account associated with the flow
    */
    @ApiMember(Description="The ID of the account associated with the flow")
    open var accountId:String? = null

    /**
    * The name of the account associated with the flow
    */
    @ApiMember(Description="The name of the account associated with the flow")
    open var accountName:String? = null

    /**
    * The ID of the customer this flow is associated with
    */
    @ApiMember(Description="The ID of the customer this flow is associated with")
    open var customerId:String? = null

    /**
    * The name of the customer this flow is associated with
    */
    @ApiMember(Description="The name of the customer this flow is associated with")
    open var customerName:String? = null

    /**
    * The breadcrumb to the flow for this endpoint
    */
    @ApiMember(Description="The breadcrumb to the flow for this endpoint")
    open var customerBreadcrumb:ArrayList<CustomerBreadcrumb>? = null

    /**
    * The nodes in this flow
    */
    @ApiMember(Description="The nodes in this flow")
    open var nodes:ArrayList<FlowNode>? = null

    /**
    * The flow's parameters
    */
    @ApiMember(Description="The flow's parameters")
    open var parameters:ArrayList<FlowParameter>? = null

    /**
    * The flow's exits
    */
    @ApiMember(Description="The flow's exits")
    open var exits:ArrayList<FlowExit>? = null

    /**
    * The UI data for the flow
    */
    @ApiMember(Description="The UI data for the flow")
    open var ui:FlowUI? = null

    /**
    * The list of tags for this flow
    */
    @ApiMember(Description="The list of tags for this flow")
    open var tags:ArrayList<Tag>? = null

    /**
    * The number of nodes in this flow
    */
    @ApiMember(Description="The number of nodes in this flow")
    open var nodeCount:Int? = null
}

open class EntityInfo
{
    /**
    * The ID of the object
    */
    @ApiMember(Description="The ID of the object")
    open var id:String? = null

    /**
    * The date the object was created
    */
    @ApiMember(Description="The date the object was created")
    open var dateCreated:String? = null

    /**
    * The date the object was last modified
    */
    @ApiMember(Description="The date the object was last modified")
    open var dateLastModified:String? = null

    /**
    * The user that created this object
    */
    @ApiMember(Description="The user that created this object")
    open var createdBy:String? = null

    /**
    * The user that last modified this object
    */
    @ApiMember(Description="The user that last modified this object")
    open var lastModifiedBy:String? = null
}

enum class FlowRoles
{
    Ui,
    Reference,
    PhoneNumberRouting,
    UserDialOut,
    FaxNumberRouting,
}

open class CustomerBreadcrumb
{
    open var id:String? = null
    open var name:String? = null
}

open class FlowNode
{
    /**
    * The ID of this node. Must be unique within the flow but can be anything
    */
    @ApiMember(Description="The ID of this node. Must be unique within the flow but can be anything")
    open var id:String? = null

    /**
    * Is this the starting node for the flow. Only one node can have this set
    */
    @ApiMember(Description="Is this the starting node for the flow. Only one node can have this set")
    open var isStartNode:Boolean? = null

    /**
    * The name of the node, descriptive to be used as a reminder in the GUI
    */
    @ApiMember(Description="The name of the node, descriptive to be used as a reminder in the GUI")
    open var name:String? = null

    /**
    * The specification for the node
    */
    @ApiMember(Description="The specification for the node")
    open var spec:FlowNodeSpec? = null

    /**
    * The UI data for the node
    */
    @ApiMember(Description="The UI data for the node")
    open var ui:FlowNodeUI? = null

    /**
    * The data for this node. These will be POST'd to the endpoint when it is called.
    */
    @ApiMember(Description="The data for this node. These will be POST'd to the endpoint when it is called.")
    open var parameters:NodeParameterMap? = null
}

open class FlowNodeSpec
{
    /**
    * The name of this node
    */
    @ApiMember(Description="The name of this node")
    open var name:String? = null

    /**
    * A description of this node
    */
    @ApiMember(Description="A description of this node")
    open var description:String? = null

    /**
    * Icon class for this node (FontAwesome)
    */
    @ApiMember(Description="Icon class for this node (FontAwesome)")
    open var iconClass:String? = null

    /**
    * The type name for this node
    */
    @ApiMember(Description="The type name for this node")
    open var typeName:String? = null

    /**
    * The category this node should be grouped under
    */
    @ApiMember(Description="The category this node should be grouped under")
    open var category:FlowNodeCategories? = null

    /**
    * The URL where this node is located
    */
    @ApiMember(Description="The URL where this node is located")
    open var url:String? = null

    /**
    * The data type for this node
    */
    @ApiMember(Description="The data type for this node")
    open var dataType:DataType? = null

    /**
    * URL for documentation for this node
    */
    @ApiMember(Description="URL for documentation for this node")
    open var documentationUrl:String? = null

    /**
    * The channels that this node is restricted to
    */
    @ApiMember(Description="The channels that this node is restricted to")
    open var restrictToChannels:ArrayList<FlowChannels>? = null
}

enum class FlowNodeCategories
{
    General,
    Voice,
    Logic,
    DateAndTime,
    Audio,
    Messaging,
    Assistant,
    Flows,
    Fax,
    Network,
    Cookies,
    CallCenter,
    Intelligence,
}

open class DataType
{
    open var typeName:String? = null
    open var fields:ArrayList<DataField>? = null
}

open class DataField
{
    open var id:String? = null
    open var name:String? = null
    @SerializedName("type") open var Type:ValueTypes? = null
    open var uiHint:UIHints? = null
    open var uiTab:String? = null
    open var isAsync:Boolean? = null
    open var disableBinding:Boolean? = null
    open var structType:DataType? = null
    open var listType:DataType? = null
    open var description:String? = null
    open var possibleValues:ArrayList<String>? = null
    open var isOutput:Boolean? = null
    open var customFieldValuesUrl:String? = null
    open var defaultValue:Value? = null
    open var transitionNameFormat:String? = null
    open var uniqueness:DataFieldUniqueness? = null
    open var voiceOnly:Boolean? = null
    open var conditionalVisibilityField:String? = null
    open var conditionalVisibilityValue:String? = null
    open var noEvalTemplate:Boolean? = null
    open var userMode:UserDataFieldModes? = null
    open var anyValueType:Boolean? = null
}

enum class ValueTypes
{
    NotSpecified,
    String,
    Boolean,
    Number,
    List,
    Struct,
    Transition,
    Custom,
    Date,
    AudioFile,
    TimeZoneId,
    PhoneNumber,
    User,
    Endpoint,
    Time,
    File,
    FaxNumber,
    EmailAccount,
    Customer,
    Flow,
    Team,
    FlowReference,
    Integration,
    Assistant,
}

enum class UIHints
{
    None,
    LargeText,
    InlineForm,
    Password,
    InlineStruct,
}

open class Value
{
    open var boolValue:Boolean? = null
    open var stringValue:String? = null
    open var numberValue:Double? = null
    open var listValue:ArrayList<Struct>? = null
    open var structValue:Struct? = null
}

open class Struct : HashMap<String,Value>()
{
}

enum class DataFieldUniqueness
{
    NotUnique,
    Unique,
    UniqueToCustomer,
}

enum class UserDataFieldModes
{
    Hidden,
    ReadOnly,
    ReadWrite,
}

enum class FlowChannels
{
    Voice,
    Chat,
    Fax,
}

open class FlowNodeUI
{
    /**
    * The X position of the node
    */
    @ApiMember(Description="The X position of the node")
    open var x:Double? = null

    /**
    * The Y position of the node
    */
    @ApiMember(Description="The Y position of the node")
    open var y:Double? = null

    /**
    * Notes for this node
    */
    @ApiMember(Description="Notes for this node")
    open var notes:String? = null
}

open class NodeParameterMap : HashMap<String,NodeParameter>()
{
}

open class NodeParameter
{
    open var id:String? = null
    @SerializedName("type") open var Type:ValueTypes? = null
    open var source:ValueSources? = null
    open var isAsync:Boolean? = null
    open var referenceId:String? = null
    open var value:Value? = null
    open var noEvalTemplate:Boolean? = null
    open var listParameters:ArrayList<NodeParameterMap>? = null
    open var structParameters:NodeParameterMap? = null
    open var isOutput:Boolean? = null
    open var expression:String? = null
    open var listType:DataType? = null
}

enum class ValueSources
{
    Value,
    Flow,
    System,
    Customer,
    Session,
    Endpoint,
    Expression,
    User,
}

open class FlowParameter : DataField()
{
    open var isPublic:Boolean? = null
    open var isKnob:Boolean? = null
}

open class FlowExit
{
    /**
    * The unique ID for this exit
    */
    @ApiMember(Description="The unique ID for this exit")
    open var id:String? = null

    /**
    * The name of this exit
    */
    @ApiMember(Description="The name of this exit")
    open var name:String? = null

    /**
    * The UI for the exit
    */
    @ApiMember(Description="The UI for the exit")
    open var ui:FlowNodeUI? = null
}

open class FlowUI
{
    open var selectedNode:String? = null
    open var canvasX:Double? = null
    open var canvasY:Double? = null
    open var canvasZoom:Double? = null
}

open class Tag
{
    open var id:String? = null
    open var name:String? = null
    open var color:TagColors? = null
}

enum class TagColors
{
    Magenta,
    Red,
    Volcano,
    Orange,
    Gold,
    Lime,
    Green,
    Cyan,
    Blue,
    GeekBlue,
    Purple,
}

Kotlin GetFlow DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv

HTTP + CSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

GET /flows/{flowId} HTTP/1.1 
Host: team.evovoice.io 
Accept: text/csv

HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"name":"String","roles":["UI"],"description":"String","notes":"String","accountId":"String","accountName":"String","customerId":"String","customerName":"String","customerBreadcrumb":[{"id":"String","name":"String"}],"nodes":[{"id":"String","isStartNode":false,"name":"String","spec":{"name":"String","description":"String","iconClass":"String","typeName":"String","category":"General","url":"String","documentationUrl":"String","restrictToChannels":["Voice"]},"ui":{"x":0,"y":0,"notes":"String"},"parameters":{}}],"parameters":[{"isPublic":false,"isKnob":false,"id":"String","name":"String","type":"NotSpecified","uiHint":"None","uiTab":"String","isAsync":false,"disableBinding":false,"description":"String","possibleValues":["String"],"isOutput":false,"customFieldValuesUrl":"String","defaultValue":{"boolValue":false,"stringValue":"String","numberValue":0,"listValue":[null]},"transitionNameFormat":"String","uniqueness":"NotUnique","voiceOnly":false,"conditionalVisibilityField":"String","conditionalVisibilityValue":"String","noEvalTemplate":false,"userMode":"Hidden","anyValueType":false}],"exits":[{"id":"String","name":"String","ui":{"x":0,"y":0,"notes":"String"}}],"ui":{"selectedNode":"String","canvasX":0,"canvasY":0,"canvasZoom":0},"tags":[{"id":"String","name":"String","color":"Magenta"}],"nodeCount":0,"id":"String","dateCreated":"String","dateLastModified":"String","createdBy":"String","lastModifiedBy":"String"}