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}

**IntegrationRule** Parameters:
Name	Parameter	Data Type	Required
WorkspaceId	path	string	No
Name	body	string	No
Data	body	Dictionary<string, Object>	No
ObjectType	body	string	No
Id	path	string	No
ConditionGroupItems	body	List<ConditionGroupItem>	No
ActionsToTake	body	List<Action>	No
LastUpdated	body	DateTime	No
ModulePipeline	body	List<RuleModuleDefinition>	No
Enabled	body	bool	No
WorkdayRestricted	body	bool	No
Teams	body	List<string>	No
AllowProgrammaticTrigger	body	bool	No

**ConditionGroupItem** Parameters:
Name	Parameter	Data Type	Required
ConditionGroups	form	List<ConditionGroup>	No
Precedence	form	int	No
GroupIdentifier	form	int	No
BooleanOperator	form	string	No

**ConditionGroup** Parameters:
Name	Parameter	Data Type	Required
Condition	form	Condition	No
Precedence	form	int	No
GroupIdentifier	form	int	No
BooleanOperator	form	string	No

**Condition** Parameters:
Name	Parameter	Data Type	Required
ValueComparedTo	form	string	No
ValueToCompare	form	string	No
ComparisonOperator	form	PossibleComparisons	No

**PossibleComparisons** Enum:
LTE
LT
GT
GTE
EQ
NE
NULL
NOTNULL
CHG
STARTS
LIKE

**Action** Parameters:
Name	Parameter	Data Type	Required
Id	form	string	No
CallType	form	string	No
ActionToTake	form	string	No
Destination	form	string	No
ExternalId	form	string	No
ExternalParentId	form	string	No
DeleteTypeIfNotExists	form	string	No
DataTree	form	Dictionary<string, Object>	No
Data	form	string	No
DataTypes	form	Dictionary<string, Object>	No

**RuleModuleDefinition** Parameters:
Name	Parameter	Data Type	Required
IsOutputModule	form	bool	No
Name	form	string	No
Prerequisites	form	List<string>	No
Parameters	form	Dictionary<string, Object>	No
Type	form	string	No
OutputAction	form	Action	No

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

HTTP + JSV

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: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	WorkspaceId: String,
	Name: String,
	Data: 
	{
		value: String
	},
	ObjectType: String,
	Id: String,
	ConditionGroupItems: 
	[
		{
			ConditionGroups: 
			[
				{
					Condition: 
					{
						ValueComparedTo: String,
						ValueToCompare: String,
						ComparisonOperator: LTE
					},
					Precedence: 0,
					GroupIdentifier: 0,
					BooleanOperator: String
				}
			],
			Precedence: 0,
			GroupIdentifier: 0,
			BooleanOperator: String
		}
	],
	ActionsToTake: 
	[
		{
			Id: String,
			CallType: String,
			ActionToTake: String,
			Destination: String,
			ExternalId: String,
			ExternalParentId: String,
			DeleteTypeIfNotExists: String,
			DataTree: 
			{
				String: {}
			},
			Data: String,
			DataTypes: 
			{
				String: {}
			}
		}
	],
	LastUpdated: 0001-01-01,
	ModulePipeline: 
	[
		{
			IsOutputModule: False,
			Name: String,
			Prerequisites: 
			[
				String
			],
			Parameters: 
			{
				String: {}
			},
			Type: String,
			OutputAction: 
			{
				Id: String,
				CallType: String,
				ActionToTake: String,
				Destination: String,
				ExternalId: String,
				ExternalParentId: String,
				DeleteTypeIfNotExists: String,
				DataTree: 
				{
					String: {}
				},
				Data: String,
				DataTypes: 
				{
					String: {}
				}
			}
		}
	],
	Enabled: False,
	WorkdayRestricted: False,
	Teams: 
	[
		String
	],
	AllowProgrammaticTrigger: False
}