Create Business Rule

This call will create a new business rule. You can only create one business rule at a time, so if you are creating multiple business rules you will need to run this for each rule.

The API can be used to create a business rule with one or more determining attributes. The key is that the determining attributes referenced in the body of your call must match the determining attributes in the coverage set you are working in. Below, we will show how to create a simple business rule (one determining attribute) and then a more complex rule (multiple determining attributes).

The call for creating the business rule is a POST call.

Create business rule API

Simple (one determining attribute)

The body of the call includes the name of the coverage set after the base context (user ID, password, and project). The coverage set you identify must be locked by the user ID you are using to send this API. You will need to send the ‘lock coverage set’ API before creating business rules.

In the ‘entity’ section, you include both the determining attribute name and value(s) in an array. Note that all values selected must exist in the determining attribute as it is defined in TDO.

{
    "context": {
        "user": "mbj_test",
        "password": "xxxx",
        "project": {
            "name": "imp_payments_demo",
            "version": "1.0"
        },
        "coverage" : {
            "name": "api_testing_coverage",
          "version": "1.1"
        }
    },
    "entity": {
        "conditions": {
          "account": {
                "values": ["Current"]
            }
    }
    }
}

When the rule is created, the return message shows the rule ID as well as the contents of the rule.

Return message business rule created

Looking at the business rules in this coverage set in TDO, you can see that the rule was set.

Simple business rule contents in TDO

Complex (multiple determining attributes)

For this call, we will use the coverage set ‘api_demo_coverage 1.1’. This coverage set has five determining attributes.

Coverage set contents in TDO

The body of the call for multiple determining attributes is set up as an array in the ‘conditions’ section. Note that you can select one or more values for each determining attribute.

{
    "context": {
        "user": "mbj_test",
        "password": "xxxx",
        "project": {
            "name": "imp_payments_demo",
            "version": "1.0"
        },
        "coverage" : {
            "name": "api_demo_coverage",
          "version": "1.2"
        }
    },
    "entity": {
        "conditions": {
          "has_app": {"values": ["0"]},
          "acct_type": {"values": ["Checking","Savings"]},
          "has_online": {"values": ["1"]},
          "currency_a": {"values": ["USD"]},
          "customer_type": {"values": ["Retail"]}      
        }   
    }
}

The response to this call will show all of the attributes you defined in the body of the message.

Return message for complex rule creation

The business rule now shows in TDO.

Complex business rule after creation