4.5 Event Suppression
This service allows Behavior Detection Framework (BDF) to consume Event Suppression information present within ECM.
This API will have non-mandatory inputs. If these inputs are provided, they will be used to filter data. If these inputs are not provided, full data will be loaded as JSON output.
The following topics explain how to configure and use the Event Suppression information:
- HTTP Link
- Service Type
- Request Parameters/Non-Mandatory Inputs
- Request JSON Sample
- Response Parameters
- Response JSON Sample
HTTP Link
http://<ApplicationURL>/rest-api/CMRestService/SupressionListRestService/
getSuppressionRulesList
Service Type
The service type is POST.
Request Parameters and Non-Mandatory Inputs
The following table describes the details of the parameters.
Table 4-9 Event Suppression - Request Parameters/Non-Mandatory Inputs
| First Level | Details |
|---|---|
| From and To Date | DD/MM/YYYY is the Expected Date format. This will be filtered against the Created date of the Suppression Rule. |
| Jurisdiction | This is filtered against the party Jurisdiction. A Suppression Record will be retrieved if it matches the Jurisdiction of any of the parties present in a Suppression record. |
| Business Domain | This is filtered against the party Business domain. A Suppression Record will be retrievedif it matches the Business Domain of any one of the parties present in a Suppression record. |
Request JSON Sample
This section contains a request JSON sample to get Event Suppression information. The entries in this sample are only for reference purposes..
{
"domain" :"abc",
"jurisdiction" : "AMEA,IND",
"fromDate": "03/05/2022",
"toDate":"07/05/2022"
}Response Parameters
The following table describes the details of the response
parameters.
Note:
The API response is in a String format.Table 4-10 Event Suppression- Response Parameters
| Business Name | API Response Data Element | Description | Data Type and Length |
|---|---|---|---|
| Suppression Code | supCode | For ECM created Suppression rules, this is the same as Suppression rule Seq (running seq). This column is added to support Third-party Suppression rules in future | String (100) |
| Suppression Sequence ID | supSeqId | Displays Running Sequence | Number (10) |
| Suppression Created ID | supCreateId | Displays ID of the user who requested the Suppression rule. It is a number | Number (10) |
| Suppression Created Date | supCreateDate | Displays the date on which the Suppression rule request was created. | Date |
| Suppression Effective Date | supEffectiveDate | Displays the Effective date of the Suppression rule record. | Date |
| Suppression Expiration Date | supExprnDate | Displays the Expiration date of the Suppression rule record | Date |
| Suppression Status Code | supStatus-Code | Displays out-of-box statuses resent in FCC_SUP_STATUS table in ECM. But the client can configure their own statuses. F_ACTIVE_FL denotes the Statuses in which we say a Suppression rule is Active. F_SHARED_FL denotes the statuses of the Suppression rule, which will be moved to BD. | - |
| Event Code | supEventCode | Displays the Event Code of the event, which was selected, and the Suppression request was made | Number (22) |
| Case ID | supCaseId | Displays the case id which was used to create the Suppression request | String (15) |
| Scenario Skey | supScenarioSkey | Displays the Scenario Skey of the Event selected | Number (10) |
| Scenario Original Skey | supScenarioOrigSkey | Displays the Scenario Original Skey fetched from FCC_SCENARIO_MASTER table using the Scenario Skey of the Event. | Number (22) |
| Entity Type | supEntityType | Displays the focus Type of the Event selected. | Varchar2(50) |
| Centricity Code | supCentricityCd | Displays the Centricity ID from kdd_centricity table using the Focus Type of Event | Number (10) |
| Entity Sequence Id | supEntitySeq | In the case of External Entity/Address focus type, External Entity Sequence/Address Sequence will be passed respectively. Else “” will be passed. | Varchar2(30) |
| Entity Id | supEntityId | In Case of Client bank, we pass instn_id_type_cd || '/' || institution_cd else the Focus Entity ID will be passed. | Varchar2(50) |
| Jurisdiction | supJrsdcnCd | Displays Jurisdiction of Event selected | String (5) |
| Business domain | supBusDmn | Displays Business domain of Event selected | String (65) |
| Last Modified by | supReviewerId | Displays the Reviewer ID. It is a number. | Number (10) |
| Last Modified date | supReviewDate | This can be considered as the Review Date | Date |
| Last Comment | supReviewComment | This can be considered as the Review Reason. | String (2500) |
| Binding Name | supBindgNm | Refers to the Binding Name of the Event selected. | String (40) |
| Binding Value | supBindgValueTx | Refers to the Binding Value of the Event selected. | String (2000) |
| Operator Code | supOprtrCode | Refers to the Comparison operator used in the Suppression Condition. | String (30) |
| Binding Description | supBindgDescTx | Refers to the Binding Description of the Event selected. | String (40) |
Response JSON Sample
This section contains a response JSON sample to get Event Suppression
information. The entries in this sample are only for reference
purposes.
{
"supCode": "160",
"supSeqId": "160",
"supCreateId": "10008",
"supCreateDate": "2022-05-07 07:10:57",
"supEffectiveDate": "2022-05-17 08:43:30",
"supExprnDate": "2022-02-17 23:59:59",
"supStatusCode": "SUPEXP",
"supEventCode": "4458",
"supCaseId": "CA135",
"supScenarioSkey": "220",
"supScenarioOrigSkey": "117350037",
"supEntityType": "EXTERNAL_ENTITY",
"supCentricityCd": "113000011",
"supEntitySeq": "100249",
"supEntityId": "405",
"supJrsdcnCd": "AMEA",
"supBusDmn": "a",
"supReviewerId": "1",
"supReviewDate": "2022-05-19 10:29:27",
"supReviewComment": "Expiring Suppression Rule as Expiration date reached",
"supBindgNm": "Trusted_Trans_Prctg",
"supBindgValueTx": "1",
"supOprtrCode": ">",
"supBindgDescTx": "% Trans w/Trusted Pairs"
}