Response parameters: BusinessRules and BusinessRuleResults sections
- Last UpdatedAug 29, 2023
- 1 minute read
The BusinessRules section contains the set of business rules, including description and results.
<BusinessRules>
<BusinessRule>
<FullName>EnterpriseFolder.SiteFolder.DowntimeReportingPoint.Business Rules.BusinessRule1</FullName>
<Name>BusinessRule1</Name>
<Explanation>Downtime 1 is greater than 10</Explanation>
<DisplayOrder>5.0</DisplayOrder>
<BackgroundColor>Red</BackgroundColor>
<TextColor>Black</TextColor>
<LookupKey>1</LookupKey>
</BusinessRule>
</BusinessRules>
|
Parameter |
Description |
|---|---|
|
FullName |
The full name and path of the business rule in the project hierarchy. For example, Plant1.Crusher.Downtime.Business Rules. Record Not Confirmed. |
|
Name |
The name of the business rule. This is a string value. For example, Not Confirmed. |
|
Explanation |
The explanation entry for the business rule. Must be a string value. For example, This record has not been confirmed yet. |
|
DisplayOrder |
The display order of the business rule. For example, 5.0. |
|
BackgroundColor |
The background color of the business rule. |
|
Text Color |
The text color of the business rule. |
|
LookupKey |
The lookup key for the business rule. This is an integer value, such as 1, 2, 3. |
The BusinessRulesResults section contains the returned data for the business rule results.
<BusinessRuleResults>
<BusinessRuleResult>
<Id>1</Id>
<LookupKeys>1</LookupKeys>
</BusinessRuleResult>
<BusinessRuleResult>
<Id>2</Id>
<LookupKeys>1</LookupKeys>
</BusinessRuleResult>
</BusinessRuleResults>
|
Parameter |
Description |
|---|---|
|
Id |
The ID of the business rule result. This is a numeric value. |
|
LookupKeys |
The lookup key of the business rule result. This is an integer value, such as 1, 2, 3. |