Field Squared API Services

<back to all web services

IntegrationRuleList

Represents a set or rules what the system reads to take a particular set of actions. These dtos allow transfer of that data from the client to the server and vice versa.

Imports System
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports Field2Office.API.Model
Imports Field2Office.API.Model.Integration

Namespace Global

    Namespace Field2Office.API.Model

        Public Partial Class Action
            Public Sub New()
                DataTree = New Dictionary(Of String, Object)
                DataTypes = New Dictionary(Of String, Object)
            End Sub

            Public Overridable Property Id As String
            Public Overridable Property CallType As String
            Public Overridable Property ActionToTake As String
            Public Overridable Property Destination As String
            Public Overridable Property ExternalId As String
            Public Overridable Property ExternalParentId As String
            Public Overridable Property DeleteTypeIfNotExists As String
            Public Overridable Property DataTree As Dictionary(Of String, Object)
            Public Overridable Property Data As String
            Public Overridable Property DataTypes As Dictionary(Of String, Object)
        End Class

        Public Partial Class Condition
            Public Overridable Property ValueComparedTo As String
            Public Overridable Property ValueToCompare As String
            Public Overridable Property ComparisonOperator As PossibleComparisons

            Public Enum PossibleComparisons
                LTE
                LT
                GT
                GTE
                EQ
                NE
                NULL
                NOTNULL
                CHG
                STARTS
                LIKE
            End Enum
        End Class

        Public Partial Class ConditionGroup
            Public Overridable Property Condition As Condition
            Public Overridable Property Precedence As Integer
            Public Overridable Property GroupIdentifier As Integer
            Public Overridable Property BooleanOperator As String
        End Class

        Public Partial Class ConditionGroupItem
            Public Sub New()
                ConditionGroups = New List(Of ConditionGroup)
            End Sub

            Public Overridable Property ConditionGroups As List(Of ConditionGroup)
            Public Overridable Property Precedence As Integer
            Public Overridable Property GroupIdentifier As Integer
            Public Overridable Property BooleanOperator As String
        End Class

        '''<Summary>
        '''Represents a set of rules what the system reads to take a particular set of actions. These dtos allow transfer of that data from the client to the server and vice versa.
        '''</Summary>
        Public Partial Class IntegrationRule
            Public Sub New()
                Data = New Dictionary(Of String, Object)
                ConditionGroupItems = New List(Of ConditionGroupItem)
                ActionsToTake = New List(Of Action)
                ModulePipeline = New List(Of RuleModuleDefinition)
                Teams = New List(Of String)
            End Sub

            Public Overridable Property WorkspaceId As String
            Public Overridable Property Name As String
            Public Overridable Property Data As Dictionary(Of String, Object)
            Public Overridable Property ObjectType As String
            Public Overridable Property Id As String
            Public Overridable Property ConditionGroupItems As List(Of ConditionGroupItem)
            Public Overridable Property ActionsToTake As List(Of Action)
            Public Overridable Property LastUpdated As Date
            Public Overridable Property ModulePipeline As List(Of RuleModuleDefinition)
            Public Overridable Property Enabled As Boolean
            Public Overridable Property WorkdayRestricted As Boolean
            Public Overridable Property Teams As List(Of String)
            Public Overridable Property AllowProgrammaticTrigger As Boolean
        End Class

        '''<Summary>
        '''Represents a set or rules what the system reads to take a particular set of actions. These dtos allow transfer of that data from the client to the server and vice versa.
        '''</Summary>
        Public Partial Class IntegrationRuleList
            Public Sub New()
                IntegrationRules = New List(Of IntegrationRule)
            End Sub

            Public Overridable Property Workspace As String
            Public Overridable Property DateGenerated As String
            Public Overridable Property IntegrationRules As List(Of IntegrationRule)
            Public Overridable Property IgnoreSecurity As Boolean
        End Class
    End Namespace

    Namespace Field2Office.API.Model.Integration

        Public Partial Class RuleModuleDefinition
            Public Sub New()
                Prerequisites = New List(Of String)
                Parameters = New Dictionary(Of String, Object)
            End Sub

            Public Overridable Property IsOutputModule As Boolean
            Public Overridable Property Name As String
            Public Overridable Property Prerequisites As List(Of String)
            Public Overridable Property Parameters As Dictionary(Of String, Object)
            Public Overridable Property Type As String
            Public Overridable Property OutputAction As Action
        End Class
    End Namespace
End Namespace

VB.NET IntegrationRuleList DTOs

GET /{Workspace}/IntegrationRuleList HTTP/1.1 
Host: dev.fieldsquared.com 
Accept: application/xml