Enable Business Events
Some business events are delivered disabled by default. You can use the ERP Business Events REST API to enable business events before subscribing to them. See the REST API for Oracle Financials Cloud guide for details.
- Privilege Name: Access FSCM Integration Rest Service
- Privilege Code: FUN_FSCM_REST_SERVICE_ACCESS_INTEGRATION_PRIV
- Get the list of all business events to be enabled.
- Identify the ErpBusinessEventId of the business event you want to enable.
- Enable business event by the ErpBusinessEventId.
Let's say you want to enable the Generate Public Events on Change in Financial Project Plan business event. You can do this using the GET and PATCH actions.
Get a list of all business event records.
Example URL
Here's an example of the resource URL:
GET
/fscmRestApi/resources/11.13.18.05/erpBusinessEvents
Example Response
Here's an example of the response body in JSON format:
{
"items" : [ ... {
"BusinessEventCode": "PlanChangeEvent",
"BusinessEventIdentifier": "PjfFoundationCommon_PlanChangeEvent",
"CreatedBy": "SEED_DATA_FROM_APPLICATION",
"CreationDate": "2021-03-06T05:30:10+00:00",
"EnabledFlag": false,
"LastUpdateDate": "2021-03-06T05:30:10.074+00:00",
"LastUpdateLogin": "-1",
"LastUpdatedBy": "SEED_DATA_FROM_APPLICATION",
"ErpBusinessEventId": 300100540951651,
"links": [...]
},
{
"BusinessEventCode": "ProjectStatusEvent",
"BusinessEventIdentifier": "PjfFoundationCommon_ProjectStatusEvent",
"CreatedBy": "SEED_DATA_FROM_APPLICATION",
"CreationDate": "2021-03-06T05:30:10.128+00:00",
"EnabledFlag": false,
"LastUpdateDate": "2021-03-06T05:30:10.130+00:00",
"LastUpdateLogin": "-1",
"LastUpdatedBy": "SEED_DATA_FROM_APPLICATION",
"ErpBusinessEventId": 300100540951652,
"links": [...]
}
Get the ErpBusinessEventId for the BusinessEventCode "PlanChangeEvent".
Example URL
Here's an example of the resource URL:
GET
/fscmRestApi/resources/11.13.18.05/erpBusinessEvents/?q=BusinessEventCode=PlanChangeEvent
Example Response
Here's an example of the response body in JSON format:
{
"items": [
{
"BusinessEventCode": "PlanChangeEvent",
"BusinessEventIdentifier": "PjfFoundationCommon_PlanChangeEvent",
"CreatedBy": "SEED_DATA_FROM_APPLICATION",
"CreationDate": "2021-03-06T05:30:10+00:00",
"EnabledFlag": false,
"LastUpdateDate": "2021-03-06T05:30:10.074+00:00",
"LastUpdateLogin": "-1",
"LastUpdatedBy": "SEED_DATA_FROM_APPLICATION",
"ErpBusinessEventId": 300100540951651,
"links": [
{
"rel": "self",
"href": "https://fuscdrmsmc265-fa-ext.us.oracle.com:443/fscmRestApi/resources/11.13.18.05/erpBusinessEvents/300100540951651",
"name": "erpBusinessEvents",
"kind": "item",
"properties": {
"changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A657870000000017704000000017372001B6F7261636C652E6A626F2E646F6D61696E2E4E756C6C56616C75655899C1C58DAABEEB02000149000A6D53514C54797065496478700000000C78"
}
},
{
"rel": "canonical",
"href": "https://fuscdrmsmc265-fa-ext.us.oracle.com:443/fscmRestApi/resources/11.13.18.05/erpBusinessEvents/300100540951651",
"name": "erpBusinessEvents",
"kind": "item"
}
]
}
],
"count": 1,
"hasMore": false,
"limit": 25,
"offset": 0,
"links": [
{
"rel": "self",
"href": "https://fuscdrmsmc265-fa-ext.us.oracle.com:443/fscmRestApi/resources/11.13.18.05/erpBusinessEvents",
"name": "erpBusinessEvents",
"kind": "collection"
}
]
}
Use the ErpBusinessEventId to enable the business event.
Example URL
Here's an example of the resource URL:
PATCH
/fscmRestApi/resources/11.13.18.05/erpBusinessEvents/300100540951651
Example Request
Here's an example of the request body in JSON format:
{
"EnabledFlag": true
}
Example Response
Here's an example of the response body in JSON format:
{
"BusinessEventCode": "PlanChangeEvent",
"BusinessEventIdentifier": "PjfFoundationCommon_PlanChangeEvent",
"CreatedBy": "SEED_DATA_FROM_APPLICATION",
"CreationDate": "2021-03-06T05:30:10+00:00",
"EnabledFlag": true,
"LastUpdateDate": "2021-07-14T14:59:46+00:00",
"LastUpdateLogin": "C662A788216975F8E053D96AF00ACDFD",
"LastUpdatedBy": "DEVON.SMITH",
"ErpBusinessEventId": 300100540951651,
"links": [
{
"rel": "self",
"href": "https://fuscdrmsmc265-fa-ext.us.oracle.com:443/fscmRestApi/resources/11.13.18.05/erpBusinessEvents/300100540951651",
"name": "erpBusinessEvents",
"kind": "item",
"properties": {
"changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000278"
}
},
{
"rel": "canonical",
"href": "https://fuscdrmsmc265-fa-ext.us.oracle.com:443/fscmRestApi/resources/11.13.18.05/erpBusinessEvents/300100540951651",
"name": "erpBusinessEvents",
"kind": "item"
}
]
}