4.1 Create Event
This service saves the event generated in the source system to the consolidation layer. The saved event will be available for correlation when the next batch is triggered.
The following topics explain how to configure and use the Create Events in JSON.
- HTTP Link
- Service Type
- Request Parameters
- Request JSON Sample
- Response Parameters
- Response JSON Sample
HTTP Link
http:// <Application
URL>/rest-api/CMRestService/RealTimeCaseCreationService/saveEvents
Service Type
The service type is POST.
Request Parameters
The following table describes the details of the parameters.
Table 4-1 Request Parameters
First Level | Second Level | Third Level | Details |
---|---|---|---|
events | - | - | This accepts basic information of the Event. |
events | eventCode | - | This accepts event ID information. |
events | eventScore | - | This accepts information about the event score. |
events | dataOrigin | - | This accepts information about the Data Origin of the event. It stores the source system from where data is extracted. |
events | jurisdictionCode | - | This accepts information about the Jurisdiction code of the event. It represents geographic or legal entity monitoring or data restrictions. |
events | businessDomain | - | This accepts information about the Business Domain of the event. Business Domain represents the operational data restrictions (that is, potential Chinese walls between business units). |
events | type | - | This accepts information about the 'Type' of the event. For example, AML, KYC, and so on. |
events | priority | - | This accepts information about the 'Priority' of the event. It is the Priority of the Event and the risk it poses to a customer or an institution. low, medium, high. |
events | scenarioClass | - | This accepts information about the 'Scenario Class' of the event. For example, ML, FR, and so on. |
events | comments | - | This accepts the additional comments provided, which are related to the generated Event, and details of the event or assignment that led to the creation of an external event that is formatted for display. |
events | entities | - | This is a second-level tag under JSON. It accepts basic information-related event and entity mapping. |
events | entities | entityCode | This accepts the entity code of the entity. It is the Entity identifier on whom the event is generated from the external system. It can be alphanumeric.For Example, Customer identifier, Account identifier on whom the event is generated. |
events | entities | entityType | This accepts the entity type of the entity. For example, Account, Customer, Employee, External_Entity, and Household. |
events | entities | entityTypeCode | This accepts the entity type code of the entity. |
events | entities | entityName | This accepts the name of the entity. |
events | entities | focusFlag | This accepts whether the entity is the Primary Focus of the event or not. List of Values are Y or N. Only one entity of an event will have the value of Y. All others will have N. |
events | entities | actId | This accepts the account internal ID of the Account. |
events | entities | genericEntityInformation | This accepts the generic entity information in the form of a JSON value. Note that a generic entity can never be a focal entity. Hence, there must be some other entity also specified in the entity array, which is the focal entity for the event. For more samples, see Supported JSON Structures for Generic Event Information. |
events | details | This is a second-level tag under JSON. It accepts additional details related to the event. | |
events | details | reason | This accepts event highlights. |
events | details | scenarioName | This accepts the event scenarioName. |
events | bindings | bindingName | This accepts the event binding name. |
events | bindings | bindingActualValu e | This accepts the actual binding value. |
events | bindings | bindingBaseValue | This accepts the binding base value. |
events | bindings | bindingType | This accepts the binding type. |
Request JSON Sample
This section contains a request JSON sample for creating events. The entries in this sample are only for reference purposes.
{
"events": [{
"eventCode": "09875456",
"eventScore": "",
"dataOrigin": "DLY",
"jurisdictionCode": "AMEA",
"businessDomain": "c",
"type": "AML_SURV",
"priority": "",
"scenarioClass": "AML",
"comments": "",
"entities": [{
"entityCode": "XXXACFTNEXTENAC-123007",
"entityType": "ACCOUNT",
"entityTypeCode": "ECM_ACCOUNT",
"entityName": "BARRY",
"focusFlag": "Y",
"actId": "XXXACFTNEXTENAC-123007"
},
{
"genericEntityInformation": {
"Customer Details": {
"Victim Name": "ABC XYZ",
"Victim SSN": "123-12-1234",
"Phone Number": "123-123-1234"
},
"Enterprise Customer Complaint": {
"Was a complaint filed": "No"
},
"Incident Details": {
"Incident Type": "Fradulent Transaction",
"Account Type": "Consumer",
"Market": "Southwest Mumbai"
}
}
}],
"details": [{
"reason": "INR2000 Suspicious
Transaction to Terror Outfits",
"scenarioName": "User Defined
Event"
}],
"bindings": [{
"bindingName":
"Effectv_Risk_Lvl",
"bindingActualValue": "50",
"bindingBaseValue": "5",
"bindingType": ""
}]
}],
"entities": [{
"entityCode": "XXXACFTNEXTENAC-123007",
"entityType": "ACCOUNT",
"jurisdiction": "AMEA",
"entityTypeCode": "ECM_ACCOUNT",
"entityName": "BARRY",
"actId": "XXXACFTNEXTENAC-123007",
"dataOrigin": "DLY",
"accName": "BARRY",
"types": "SAV",
"registration": "IND",
"ownerType": "",
"status": "A",
"branch": "BRANCH-001",
"taxCode": "N",
"householdGroupId": "",
"pimeBroker": "N",
"taxId": "T",
"firmId": "MANTAS",
"legalEntity": "BGMC_ACCT_001",
"statusEffective": "31-12-2014 00:00:00",
"lastActivity": "30-11-2015 00:00:00",
"openData": "31-12-2014 00:00:00",
"closeDate": ""
}]
}
Note:
From Oracle Financial Services Enterprise Case Management Release 8.1.2.2.0, capture of Generic information about entities such as Customer, Account and External entity are supported as part of Event Creation. See Sample JSONs for Sample JSONs.Response Parameters
The following table describes the details of the response parameters.
Table 4-2 Response Parameters
First Level | Details |
---|---|
Message | Displays the message of service execution. |
Status | Displays the status as Success or Fail. |
Event Id(s) | Displays all Event IDs that were passed in the request JSON. Will show multiple event IDs if more than one was passed in input JSON. |
Response JSON Sample
This section contains a response JSON sample for creating events. The entries in this
sample are only for reference
purposes.
{
"MESSAGE": "Events are saved successfully.",
"STATUS": "SUCCESS",
"Event Id(s)": "09875456"
}