SOAP Documentation: Business Rules

Overview

This resource provides methods to manage your TraceGains configuration and Item attribute Business Rules.

Operations List

The Operations List for this resource: Business Rules Operations List.

Resource WSDL

The WSDL for this resource can be found here: Business Rules WSDL.

Endpoint URLs

All requests should be sent to one of the following:
      Production Environment: https://api.tracegains.net/v7/soap/BusinessRules.asmx.
      Test Environment: https://api-test.tracegains.net/v7/soap/BusinessRules.asmx.

AddRule

Enterprise | SM SC SPM FM QM

 Adds a new rule to an existing business rule header.


Request:

Parameter Type Description
appKey Guid A registered and active Application Key.
sessionId Guid An active Session ID.
rule BusinessRule The BusinessRule definition to create.

Response:
RequestResult The default response. This response can take on a different XML element name depending on the development IDE/toolset being used.

Create

Enterprise | SM SC SPM FM QM

 Creates a new Business Rule Header for a configuration or Item attribute.


Request:

Parameter Type Description
appKey Guid A registered and active Application Key.
sessionId Guid An active Session ID.
attributeId String The Attribute ID for the business rule header.
itemId String (Optional) The Item ID for the business rule header if specific to an Item attribute.
businessRuleHeader BusinessRuleHeader The BusinessRuleHeader definition to create.

Response:
RequestResult The default response. This response can take on a different XML element name depending on the development IDE/toolset being used.

Delete

Enterprise | SM SC SPM FM QM

 Deletes a Business Rule Header by its ID.

Notes:

All Business Rules assigned to the Business Rule Header will be deleted!


Request:

Parameter Type Description
appKey Guid A registered and active Application Key.
sessionId Guid An active Session ID.
businessRuleHeaderId Integer The ID of the Business Rule Header to delete.

Response:
RequestResult The default response. This response can take on a different XML element name depending on the development IDE/toolset being used.

Get

Enterprise | SM SC SPM FM QM

 Gets a single Business Rule header and all rules for a configuration or Item attribute.


Request:

Parameter Type Description
appKey Guid A registered and active Application Key.
sessionId Guid An active Session ID.
attributeId String The Attribute ID of the business rule header to return.
itemId String (Optional) The Item ID if the business rule header if specific to an Item attribute.

Response:

Element Type Description
ResponseCode ResponseCode A valid HTTP status code.
Message String A log friendly message.
BusinessRuleHeader BusinessRuleHeader The returned Business Rule Header.

ListRuleActions

Enterprise | SM SC SPM FM QM

 Lists all active Action values available for a business rule.


Request:

Parameter Type Description
appKey Guid A registered and active Application Key.
sessionId Guid An active Session ID.

Response:
ListResult This response could take on a different XML element name by method.

ListRuleColors

Enterprise | SM SC SPM FM QM

 Lists all available Color values that can be used for foreground and background highlighting of input form fields and grid column values.


Request:

Parameter Type Description
appKey Guid A registered and active Application Key.
sessionId Guid An active Session ID.

Response:
ListResult This response could take on a different XML element name by method.

ListRuleStatuses

Enterprise | SM SC SPM FM QM

 Lists all active Status values available for a business rule.


Request:

Parameter Type Description
appKey Guid A registered and active Application Key.
sessionId Guid An active Session ID.

Response:
ListResult This response could take on a different XML element name by method.

Update

Enterprise | SM SC SPM FM QM

 Updates an existing Businiess Rule Header.


Request:

Parameter Type Description
appKey Guid A registered and active Application Key.
sessionId Guid An active Session ID.
attributeId String The Attribute ID of the business rule header to update.
itemId String (Optional) The Item ID of the business rule header to update.
businessRuleHeader BusinessRuleHeader The BusinessRuleHeader definition to update.

Response:
RequestResult The default response. This response can take on a different XML element name depending on the development IDE/toolset being used.

RemoveRule

Enterprise | SM SC SPM FM QM

 Removes a business rule from an existing business rule header.


Request:

Parameter Type Description
appKey Guid A registered and active Application Key.
sessionId Guid An active Session ID.
businessRuleHeaderId Integer The ID of the Business Rule Header that contains the rule to remove.
businessRuleId Integer The ID of the Business Rule to remove.

Response:
RequestResult The default response. This response can take on a different XML element name depending on the development IDE/toolset being used.

Version

 Reports the version information of this resource.


Request:

No Parameters


Response:

Element Type Description
ResponseCode ResponseCode A valid HTTP Status Code
Message String A log friendly message that can be used in troubleshooting a failed response.
Version String The major, minor, and build number of this resource.