<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.
The following routes are available for this service:| GET | /{Workspace}/IntegrationRuleList | | |
|---|
| GET | /{Workspace}/IntegrationRuleList/{IgnoreSecurity} | | |
|---|
IntegrationRuleList Parameters:| Name | Parameter | Data Type | Required | Description |
|---|
| Workspace | path | string | No | |
| DateGenerated | query | string | No | |
| IntegrationRules | query | List<IntegrationRule> | No | |
| IgnoreSecurity | path | bool | No | |
IntegrationRule Parameters:| Name | Parameter | Data Type | Required | Description |
|---|
| WorkspaceId | form | string | No | |
| Name | form | string | No | |
| Data | form | Dictionary<string, Object> | No | |
| ObjectType | form | string | No | |
| Id | form | string | No | |
| ConditionGroupItems | form | List<ConditionGroupItem> | No | |
| ActionsToTake | form | List<Action> | No | |
| LastUpdated | form | DateTime | No | |
| ModulePipeline | form | List<RuleModuleDefinition> | No | |
| Enabled | form | bool | No | |
| WorkdayRestricted | form | bool | No | |
| Teams | form | List<string> | No | |
| AllowProgrammaticTrigger | form | bool | No | |
ConditionGroupItem Parameters:| Name | Parameter | Data Type | Required | Description |
|---|
| ConditionGroups | form | List<ConditionGroup> | No | |
| Precedence | form | int | No | |
| GroupIdentifier | form | int | No | |
| BooleanOperator | form | string | No | |
ConditionGroup Parameters:| Name | Parameter | Data Type | Required | Description |
|---|
| Condition | form | Condition | No | |
| Precedence | form | int | No | |
| GroupIdentifier | form | int | No | |
| BooleanOperator | form | string | No | |
Condition Parameters:| Name | Parameter | Data Type | Required | Description |
|---|
| 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 | Description |
|---|
| 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 | Description |
|---|
| 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 .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.
GET /{Workspace}/IntegrationRuleList HTTP/1.1
Host: dev.fieldsquared.com
Accept: application/xml