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.

You must first have this privilege to use the ERP Business Events REST API:

Privilege Name: Access FSCM Integration Rest Service
Privilege Code: FUN_FSCM_REST_SERVICE_ACCESS_INTEGRATION_PRIV

Now follow these steps to enable a business event:

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 Receivables Invoice Paid business event. You can do this using the GET and PATCH actions.

Get All Business Event Records

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" : "ReceivablesInvoiceCompleted",
    "BusinessEventIdentifier" : "FinArShared_Receivables_Invoice_Completed",
    "CreatedBy" : "SEED_DATA_FROM_APPLICATION",
    "CreationDate" : "2018-12-27T09:43:55.243+00:00",
    "EnabledFlag" : false,
    "LastUpdateDate" : "2019-03-19T03:20:23.986+00:00",
    "LastUpdateLogin" : "-1",
    "LastUpdatedBy" : "SEED_DATA_FROM_APPLICATION",
    "ErpBusinessEventId" : 100100104470418,
    "links" : [...]
  }, {
    "BusinessEventCode" : "ReceivablesInvoiceIncompleted",
    "BusinessEventIdentifier" : "FinArShared_Receivables_Invoice_Incompleted",
    "CreatedBy" : "SEED_DATA_FROM_APPLICATION",
    "CreationDate" : "2018-12-27T09:43:55.243+00:00",
    "EnabledFlag" : false,
    "LastUpdateDate" : "2019-03-19T03:20:23.986+00:00",
    "LastUpdateLogin" : "-1",
    "LastUpdatedBy" : "SEED_DATA_FROM_APPLICATION",
    "ErpBusinessEventId" : 100100104470419,
    "links" : [...]
  }, {
    "BusinessEventCode" : "ReceivablesInvoicePaid",
    "BusinessEventIdentifier" : "FinArShared_Receivables_Invoice_Paid",
    "CreatedBy" : "SEED_DATA_FROM_APPLICATION",
    "CreationDate" : "2018-12-27T09:43:55.243+00:00",
    "EnabledFlag" : false,
    "LastUpdateDate" : "2019-03-19T03:20:23.986+00:00",
    "LastUpdateLogin" : "-1",
    "LastUpdatedBy" : "SEED_DATA_FROM_APPLICATION",
    "ErpBusinessEventId" : 100100104470420,
    "links" : [...]
}

Get a Business Event Record

Get the ErpBusinessEventId for the BusinessEventCode "ReceivablesInvoicePaid".

Example URL

Here's an example of the resource URL:

GET

/fscmRestApi/resources/11.13.18.05/erpBusinessEvents/?q=BusinessEventCode=ReceivablesInvoicePaid

Example Response

Here's an example of the response body in JSON format:

{
  "items" : [ {
    "BusinessEventCode" : "ReceivablesInvoicePaid",
    "BusinessEventIdentifier" : "FinArShared_Receivables_Invoice_Paid",
    "CreatedBy" : "SEED_DATA_FROM_APPLICATION",
    "CreationDate" : "2018-12-27T09:43:55.243+00:00",
    "EnabledFlag" : false,
    "LastUpdateDate" : "2019-03-19T03:20:23.986+00:00",
    "LastUpdateLogin" : "-1",
    "LastUpdatedBy" : "SEED_DATA_FROM_APPLICATION",
    "ErpBusinessEventId" : 100100104470420,
    "links" : [...]
  } ]
}

Update the Enabled Indicator for a Business Event

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/100100104470420

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" : "ReceivablesInvoicePaid",
  "BusinessEventIdentifier" : "FinArShared_Receivables_Invoice_Paid",
  "CreatedBy" : "SEED_DATA_FROM_APPLICATION",
  "CreationDate" : "2018-12-27T09:43:55.243+00:00",
  "EnabledFlag" : true,
  "LastUpdateDate" : "2019-08-08T18:37:51+00:00",
  "LastUpdateLogin" : "8B7030F9E91B0830E053EDC4F20A5EC1",
  "LastUpdatedBy" : "FINUSER1",
  "ErpBusinessEventId" : 100100104470420,
  "links" : [...]
}