Field Squared API Services

IntegrationRule

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.

The following routes are available for this service:
GET,PUT,DELETE	/{WorkspaceId}/IntegrationRule/{Id}

namespace Field2Office.API.Model

open System
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    type PossibleComparisons =
        | LTE = 0
        | LT = 1
        | GT = 2
        | GTE = 3
        | EQ = 4
        | NE = 5
        | NULL = 6
        | NOTNULL = 7
        | CHG = 8
        | STARTS = 9
        | LIKE = 10

    [<AllowNullLiteral>]
    type Condition() = 
        member val ValueComparedTo:String = null with get,set
        member val ValueToCompare:String = null with get,set
        member val ComparisonOperator:PossibleComparisons = new PossibleComparisons() with get,set

    [<AllowNullLiteral>]
    type ConditionGroup() = 
        member val Condition:Condition = null with get,set
        member val Precedence:Int32 = new Int32() with get,set
        member val GroupIdentifier:Int32 = new Int32() with get,set
        member val BooleanOperator:String = null with get,set

    [<AllowNullLiteral>]
    type ConditionGroupItem() = 
        member val ConditionGroups:ResizeArray<ConditionGroup> = new ResizeArray<ConditionGroup>() with get,set
        member val Precedence:Int32 = new Int32() with get,set
        member val GroupIdentifier:Int32 = new Int32() with get,set
        member val BooleanOperator:String = null with get,set

    [<AllowNullLiteral>]
    type Action() = 
        member val Id:String = null with get,set
        member val CallType:String = null with get,set
        member val ActionToTake:String = null with get,set
        member val Destination:String = null with get,set
        member val ExternalId:String = null with get,set
        member val ExternalParentId:String = null with get,set
        member val DeleteTypeIfNotExists:String = null with get,set
        member val DataTree:Dictionary<String, Object> = new Dictionary<String, Object>() with get,set
        member val Data:String = null with get,set
        member val DataTypes:Dictionary<String, Object> = new Dictionary<String, Object>() with get,set

    [<AllowNullLiteral>]
    type RuleModuleDefinition() = 
        member val IsOutputModule:Boolean = new Boolean() with get,set
        member val Name:String = null with get,set
        member val Prerequisites:ResizeArray<String> = new ResizeArray<String>() with get,set
        member val Parameters:Dictionary<String, Object> = new Dictionary<String, Object>() with get,set
        member val Type:String = null with get,set
        member val OutputAction:Action = null with get,set

    ///<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>
    [<AllowNullLiteral>]
    type IntegrationRule() = 
        member val WorkspaceId:String = null with get,set
        member val Name:String = null with get,set
        member val Data:Dictionary<String, Object> = new Dictionary<String, Object>() with get,set
        member val ObjectType:String = null with get,set
        member val Id:String = null with get,set
        member val ConditionGroupItems:ResizeArray<ConditionGroupItem> = new ResizeArray<ConditionGroupItem>() with get,set
        member val ActionsToTake:ResizeArray<Action> = new ResizeArray<Action>() with get,set
        member val LastUpdated:DateTime = new DateTime() with get,set
        member val ModulePipeline:ResizeArray<RuleModuleDefinition> = new ResizeArray<RuleModuleDefinition>() with get,set
        member val Enabled:Boolean = new Boolean() with get,set
        member val WorkdayRestricted:Boolean = new Boolean() with get,set
        member val Teams:ResizeArray<String> = new ResizeArray<String>() with get,set
        member val AllowProgrammaticTrigger:Boolean = new Boolean() with get,set

F# IntegrationRule DTOs

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

HTTP + XML

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

PUT /{WorkspaceId}/IntegrationRule/{Id} HTTP/1.1 
Host: dev.fieldsquared.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<IntegrationRule xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Field2Office.API.Model">
  <ActionsToTake>
    <Action>
      <ActionToTake>String</ActionToTake>
      <CallType>String</CallType>
      <Data>String</Data>
      <DataTree xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:KeyValueOfstringanyType>
          <d4p1:Key>String</d4p1:Key>
          <d4p1:Value />
        </d4p1:KeyValueOfstringanyType>
      </DataTree>
      <DataTypes xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:KeyValueOfstringanyType>
          <d4p1:Key>String</d4p1:Key>
          <d4p1:Value />
        </d4p1:KeyValueOfstringanyType>
      </DataTypes>
      <DeleteTypeIfNotExists>String</DeleteTypeIfNotExists>
      <Destination>String</Destination>
      <ExternalId>String</ExternalId>
      <ExternalParentId>String</ExternalParentId>
      <Id>String</Id>
    </Action>
  </ActionsToTake>
  <AllowProgrammaticTrigger>false</AllowProgrammaticTrigger>
  <ConditionGroupItems>
    <ConditionGroupItem>
      <BooleanOperator>String</BooleanOperator>
      <ConditionGroups>
        <ConditionGroup>
          <BooleanOperator>String</BooleanOperator>
          <Condition>
            <ComparisonOperator>LTE</ComparisonOperator>
            <ValueComparedTo>String</ValueComparedTo>
            <ValueToCompare>String</ValueToCompare>
          </Condition>
          <GroupIdentifier>0</GroupIdentifier>
          <Precedence>0</Precedence>
        </ConditionGroup>
      </ConditionGroups>
      <GroupIdentifier>0</GroupIdentifier>
      <Precedence>0</Precedence>
    </ConditionGroupItem>
  </ConditionGroupItems>
  <Data xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:KeyValueOfstringanyType>
      <d2p1:Key>value</d2p1:Key>
      <d2p1:Value xmlns:d4p1="http://www.w3.org/2001/XMLSchema" i:type="d4p1:string">String</d2p1:Value>
    </d2p1:KeyValueOfstringanyType>
  </Data>
  <Enabled>false</Enabled>
  <Id>String</Id>
  <LastUpdated>0001-01-01T00:00:00</LastUpdated>
  <ModulePipeline xmlns:d2p1="http://schemas.datacontract.org/2004/07/Field2Office.API.Model.Integration">
    <d2p1:RuleModuleDefinition>
      <d2p1:IsOutputModule>false</d2p1:IsOutputModule>
      <d2p1:Name>String</d2p1:Name>
      <d2p1:OutputAction>
        <ActionToTake>String</ActionToTake>
        <CallType>String</CallType>
        <Data>String</Data>
        <DataTree xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringanyType>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value />
          </d5p1:KeyValueOfstringanyType>
        </DataTree>
        <DataTypes xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringanyType>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value />
          </d5p1:KeyValueOfstringanyType>
        </DataTypes>
        <DeleteTypeIfNotExists>String</DeleteTypeIfNotExists>
        <Destination>String</Destination>
        <ExternalId>String</ExternalId>
        <ExternalParentId>String</ExternalParentId>
        <Id>String</Id>
      </d2p1:OutputAction>
      <d2p1:Parameters xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:KeyValueOfstringanyType>
          <d4p1:Key>String</d4p1:Key>
          <d4p1:Value />
        </d4p1:KeyValueOfstringanyType>
      </d2p1:Parameters>
      <d2p1:Prerequisites xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>String</d4p1:string>
      </d2p1:Prerequisites>
      <d2p1:Type>String</d2p1:Type>
    </d2p1:RuleModuleDefinition>
  </ModulePipeline>
  <Name>String</Name>
  <ObjectType>String</ObjectType>
  <Teams xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </Teams>
  <WorkdayRestricted>false</WorkdayRestricted>
  <WorkspaceId>String</WorkspaceId>
  <_data>String</_data>
</IntegrationRule>