Field Squared API Services

<back to all web 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.

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

namespace Field2Office.API.Model
{
    public partial class Action
    {
        public Action()
        {
            DataTree = new Dictionary<string, Object>{};
            DataTypes = new Dictionary<string, Object>{};
        }

        public virtual string Id { get; set; }
        public virtual string CallType { get; set; }
        public virtual string ActionToTake { get; set; }
        public virtual string Destination { get; set; }
        public virtual string ExternalId { get; set; }
        public virtual string ExternalParentId { get; set; }
        public virtual string DeleteTypeIfNotExists { get; set; }
        public virtual Dictionary<string, Object> DataTree { get; set; }
        public virtual string Data { get; set; }
        public virtual Dictionary<string, Object> DataTypes { get; set; }
    }

    public partial class Condition
    {
        public virtual string ValueComparedTo { get; set; }
        public virtual string ValueToCompare { get; set; }
        public virtual PossibleComparisons ComparisonOperator { get; set; }
        public enum PossibleComparisons
        {
            LTE,
            LT,
            GT,
            GTE,
            EQ,
            NE,
            NULL,
            NOTNULL,
            CHG,
            STARTS,
            LIKE,
        }

    }

    public partial class ConditionGroup
    {
        public virtual Condition Condition { get; set; }
        public virtual int Precedence { get; set; }
        public virtual int GroupIdentifier { get; set; }
        public virtual string BooleanOperator { get; set; }
    }

    public partial class ConditionGroupItem
    {
        public ConditionGroupItem()
        {
            ConditionGroups = new List<ConditionGroup>{};
        }

        public virtual List<ConditionGroup> ConditionGroups { get; set; }
        public virtual int Precedence { get; set; }
        public virtual int GroupIdentifier { get; set; }
        public virtual string BooleanOperator { 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>
    public partial class IntegrationRule
    {
        public IntegrationRule()
        {
            Data = new Dictionary<string, Object>{};
            ConditionGroupItems = new List<ConditionGroupItem>{};
            ActionsToTake = new List<Action>{};
            ModulePipeline = new List<RuleModuleDefinition>{};
            Teams = new List<string>{};
        }

        public virtual string WorkspaceId { get; set; }
        public virtual string Name { get; set; }
        public virtual Dictionary<string, Object> Data { get; set; }
        public virtual string ObjectType { get; set; }
        public virtual string Id { get; set; }
        public virtual List<ConditionGroupItem> ConditionGroupItems { get; set; }
        public virtual List<Action> ActionsToTake { get; set; }
        public virtual DateTime LastUpdated { get; set; }
        public virtual List<RuleModuleDefinition> ModulePipeline { get; set; }
        public virtual bool Enabled { get; set; }
        public virtual bool WorkdayRestricted { get; set; }
        public virtual List<string> Teams { get; set; }
        public virtual bool AllowProgrammaticTrigger { get; set; }
    }

}

namespace Field2Office.API.Model.Integration
{
    public partial class RuleModuleDefinition
    {
        public RuleModuleDefinition()
        {
            Prerequisites = new List<string>{};
            Parameters = new Dictionary<string, Object>{};
        }

        public virtual bool IsOutputModule { get; set; }
        public virtual string Name { get; set; }
        public virtual List<string> Prerequisites { get; set; }
        public virtual Dictionary<string, Object> Parameters { get; set; }
        public virtual string Type { get; set; }
        public virtual Action OutputAction { get; set; }
    }

}

C# IntegrationRule DTOs

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>