AddRefreshEvent() Method
- Last UpdatedJan 27, 2022
- 1 minute read
The AddRefreshEvent() method adds events for a Dimension object or Measure object (without the date range).
URL: http://<BI Gateway server name>:<Port Number>/BIGateway/Event/AddRefreshEvent
Note: You must explicitly state the computer name when calling the REST API. Make sure that localhost is not used when BI Gateway is installed on the same node.
Request
|
Parameter Type |
Parameter Name |
Description |
Data Type |
|
Input Request |
ObjectName |
The Dimension or Measure object name. For example : Dimension_001 |
String |
Return Value:
A GUID (e.g.: 00000000-0000-0000-0000-000000000000) is returned corresponding to the event created in the database. If the AddRefreshEvent() method fails, an error is logged in the ArchestrA Logger and the API returns a value of zero.
Postman Example
The following Postman code snippet shows the example for the query.
{"ObjectName":"Dimension_001"}
If the query is successful, the relevant GUID is displayed as a response.