AddRefreshEvent() method
- Last UpdatedAug 23, 2024
- 1 minute read
The AddRefreshEvent() method adds events for a Dimension object or Measure object (without the date range).
Note: When you invoke this method to a measure object, the whole backfill processing gets invoked.
URL: https://<BI Gateway URL>/eventapi/odata/Event/AddRefreshEvent
For example: https://eu.v2.bigateway.connect.aveva.com/eventapi/odata/Event/AddRefreshEvent
Important Note: You are required to add the TenantID as a header. For example, 'x-wwTenantID'.
For more information on how to identify the tenant ID, see Identify the tenant ID.
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 (for example: 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 Application Insight and the API returns a value of zero.
Postman example
The following Postman code snippets show the examples for the query.
Note: Replace the value for Dimension or Measure according to your requirement.
"Dimension_001"
Or
"Measure_001"
If the query is successful, the relevant GUID is displayed as a response.
For more information about Postman installation and configuration, see Configuring Postman Settings.