BREAGEN Logo
List Management

Rule Management

Rule Operations provide comprehensive management of rules, including creating, updating, retrieving, and deleting rules. This also includes listing all rules for easy monitoring and response.

Rule Management - Add Rule POST /v1/api/rule_managemenet/add

Resource URL/v1/api/rule_managemenet/add
Response FormatJSON
Requires AuthenticationYes
Rate LimitedYes
HTTPSYes

Parameters

Example Request

curl -X 'POST' \
'https://lm-gen-1.braegen.ai/v1/api/rule_management/add' \
-H 'accept: application/json' \
-H 'Content-Type: application/json' \
-d '{
    "rule_name": "INV-001",
    "response_code": "INVESTIGATION_REQUIRED",
    "response_type": "text",
    "encryption": "ecc",
    "return_type": "single_results",
    "rule": [
        {"field": "hits",
                "operator": ">",
                "value": "1000"}
    ],
    "client_id": "client_1",
    "create_user": "[email protected]"
}'

HTTP Responses

HTTP CodeMessage
200Success
403Authentication Required

Example Response

{
    "is_error": false,
    "message": "Add Rule Process Success",
    "results": {
        "response_type": "text",
        "id": 13,
        "return_type": "single_results",
        "client_id": "client_1",
        "create_datetime": "2024-06-12T06:15:15",
        "rule_name": "INV-001",
        "response_code": "INVESTIGATION_REQUIRED",
        "encryption": "ecc",
        "rule": [
        {
            "field": "hits",
            "operator": ">",
            "value": "1000"
        }
        ],
        "create_user": "[email protected]"
    }
    }

HTTP Responses

HTTP CodeMessage
200Succcess
204No Content
400Bad Request
401Unauthorized
403Invalid Input
404invalid or not founc type

Rule Management - Add Public Watchlist GET /v1/api/rule_managemenet/get_all_rules

Resource URL/v1/api/rule_managemenet/get_all_rules
Response FormatJson
Requires AuthenticationYes
Rate LimitedYes
HTTPSYes

Example Request

curl -X 'GET' \
'https://lm-gen-1.braegen.ai/v1/api/rule_management/get_all_rules' \
-H 'accept: application/json'

HTTP Responses

HTTP CodeMessage
200Success
403Authentication Required
{
    "is_error": false,
    "message": "Rule Get By Id Success",
    "results": [
        {
            "response_type": "text",
            "id": 2,
            "return_type": "single_results",
            "client_id": "client_1",
            "create_datetime": "2024-05-15T22:58:36",
            "rule_name": "INV-001",
            "response_code": "INVESTIGATION_REQUIRED",
            "encryption": "ecc",
            "rule": [
                {
                "field": "hits",
                "operator": ">",
                "value": "1000"
                },
                {
                "field": "match_from_country",
                "operator": "!=",
                "value": "India",
                "connector": "AND"
                }
            ],
            "create_user": "[email protected]"
        },
        {
            "response_type": "xml",
            "id": 3,
            "return_type": "single_results",
            "client_id": "client_1",
            "create_datetime": "2024-05-15T23:16:45",
            "rule_name": "Single-Result-Reject-mode",
            "response_code": "Reject",
            "encryption": "aes",
            "rule": [
                {
                "field": "hits",
                "operator": "<",
                "value": "1500"
                },
                {
                "field": "match_from_country",
                "operator": "=",
                "value": "SL",
                "connector": "AND"
                }
            ],
            "create_user": "[email protected]"
        }
    ]
}

HTTP Responses

HTTP CodeMessage
200Succcess
204No Content
400Bad Request
401Unauthorized
403Invalid Input
404invalid or not founc type

Rule Management - Get Rule By Id GET /v1/api/rule_managemenet/rule_get_by_id

Resource URL/v1/api/rule_managemenet/rule_get_by_id
Response FormatJson
Requires AuthenticationYes
Rate LimitedYes
HTTPSYes

Parameters

Example Request

curl -X 'GET' \
'https://lm-gen-1.braegen.ai/v1/api/rule_management/rule_get_by_id?rule_id=2' \
-H 'accept: application/json'

HTTP Responses

HTTP CodeMessage
200Success
403Authentication Required
{
    "is_error": false,
    "message": "Rule Get By Id Success",
    "results": {
        "response_type": "text",
        "id": 2,
        "return_type": "single_results",
        "client_id": "client_1",
        "create_datetime": "2024-05-15T22:58:36",
        "rule_name": "INV-001",
        "response_code": "INVESTIGATION_REQUIRED",
        "encryption": "ecc",
        "rule": [
        {
            "field": "hits",
            "operator": ">",
            "value": "1000"
        },
        {
            "field": "match_from_country",
            "operator": "!=",
            "value": "India",
            "connector": "AND"
        }
        ],
        "create_user": "[email protected]"
    }
}

HTTP Responses

HTTP CodeMessage
200Succcess
204No Content
400Bad Request
401Unauthorized
403Invalid Input
404invalid or not founc type

Rule Management - Update Rule By ID PUT /v1/api/rule_managemenet/update_rule_by_id

Resource URL/v1/api/rule_managemenet/update_rule_by_id
Response FormatJson
Requires AuthenticationYes
Rate LimitedYes
HTTPSYes

Parameters

Example Request

curl -X 'PUT' \
'https://lm-gen-1.braegen.ai/v1/api/rule_management/update_rule_by_id?rule_id=11' \
-H 'accept: application/json' \
-H 'Content-Type: application/json' \
-d '{
    "rule_name": "INV-001",
    "response_code": "INVESTIGATION_REQUIRED",
    "response_type": "text",
    "encryption": "ecc",
    "return_type": "single_results",
    "rule": [
        {
        "field": "hits",
        "operator": ">",
        "value": "1000"
        }
    ],
    "client_id": "client_1",
    "create_user": "[email protected]"
}'

HTTP Responses

HTTP CodeMessage
200Success
403Authentication Required

Example Request

{
    "is_error": false,
    "message": "Rule Update By Id Success",
    "results": {
        "response_type": "text",
        "id": 2,
        "return_type": "single_results",
        "client_id": "client_1",
        "create_datetime": "2024-05-15T22:58:36",
        "rule_name": "INV-001",
        "response_code": "INVESTIGATION_REQUIRED",
        "encryption": "ecc",
        "rule": [
        {
            "field": "hits",
            "operator": ">",
            "value": "1000"
        }
        ],
        "create_user": "[email protected]"
    }
}
HTTP CodeMessage
200Succcess
204No Content
400Bad Request
401Unauthorized
403Invalid Input
404invalid or not founc type

Rule Management - Delete Rule By ID DELETE /v1/api/rule_managemenet/delete_rule_by_id

Resource URL/v1/api/rule_managemenet/delete_rule_by_id
Response FormatJson
Requires AuthenticationYes
Rate LimitedYes
HTTPSYes

Parameters

Example Request

curl -X 'DELETE' \
'https://lm-gen-1.braegen.ai/v1/api/rule_management/delete_rule_by_id?rule_id=11' \
-H 'accept: application/json'

HTTP Responses

HTTP CodeMessage
200Success
403Authentication Required

Example Request

{
    "is_error": false,
    "message": "Rule Delete By Id Success",
    "results": true
}
HTTP CodeMessage
200Succcess
204No Content
400Bad Request
401Unauthorized
403Invalid Input
404invalid or not founc type

Rule Management - Get All Rules With Pagination GET /v1/api/rule_management/get_all_rules_with_pagination

Resource URL/v1/api/rule_management/get_all_rules_with_pagination
Response FormatJSON
Requires AuthenticationYes
Rate LimitedYes
HTTPSYes

Parameters

ParameterDescription
page_noPage number to get, keep default as 1
page_sizeNumber of records per page

Example Request

curl -X 'GET' \
'https://lm-gen-1.braegen.ai/v1/api/rule_management/get_all_rules_with_pagination?page_no=1&page_size=10' \
-H 'accept: application/json' \
-H 'Authorization: Bearer YOUR_API_KEY'

HTTP Responses

HTTP CodeMessage
200Success
403Authentication Required

Example Response

{
    "is_error": false,
    "message": "Rules retrieved successfully",
    "page_no": 1,
    "page_size": 10,
    "total_pages": 2,
    "total": 15,
    "rules": [
        {
            "rule_id": 1,
            "rule_name": "High Risk Countries",
            "response_code": "HR_001",
            "response_type": "boolean",
            "encryption": "none",
            "return_type": "json",
            "rule": [
                {
                    "condition": "country_code",
                    "operator": "in",
                    "value": ["NK", "IR", "CU"]
                }
            ],
            "client_id": "client_1",
            "create_user": "[email protected]",
            "create_datetime": "2024-05-15T00:00:00",
            "update_datetime": null
        }
    ]
}

HTTP Responses

HTTP CodeMessage
200Success
204No Content
400Bad Request
401Unauthorized
404Invalid page number or missing
404Invalid page size or missing

Previous

List Data Management

Next

E-mail Template Operations

On this page

Rule Management - Add Rule POST /v1/api/rule_managemenet/addParametersExample RequestHTTP ResponsesExample ResponseHTTP ResponsesRule Management - Add Public Watchlist GET /v1/api/rule_managemenet/get_all_rulesExample RequestHTTP ResponsesHTTP ResponsesRule Management - Get Rule By Id GET /v1/api/rule_managemenet/rule_get_by_idParametersExample RequestHTTP ResponsesHTTP ResponsesRule Management - Update Rule By ID PUT /v1/api/rule_managemenet/update_rule_by_idParametersExample RequestHTTP ResponsesExample RequestRule Management - Delete Rule By ID DELETE /v1/api/rule_managemenet/delete_rule_by_idParametersExample RequestHTTP ResponsesExample RequestRule Management - Get All Rules With Pagination GET /v1/api/rule_management/get_all_rules_with_paginationParametersExample RequestHTTP ResponsesExample ResponseHTTP Responses