AddDimensionDateRangeEvent() Method
- Last UpdatedJan 27, 2022
- 2 minute read
The AddDimensionDateRangeEvent() method adds events to reprocess a date range of a dimension. The date range consists of a start and an end date (including time). This will trigger the Intelligence Service to reprocess the time slices of the date range.
URL: http://<BI Gateway server name>:<Port Number>/BIGateway/Event/AddDimensionDateRangeEvent
Note: You must explicitly state the computer name when calling the REST API. Make sure that localhost is not used.
Request
|
Parameter Type |
Parameter Name |
Description |
Data Type |
|
Input Request |
jsonstring |
The Data Transfer Object which holds three attributes: Object name, StartDate, EndDate. |
DTO/ IEventDetails |
All DTOs should implement "IEventDetails" interface given below. The following sample code is for the C# programming language.
public interface IEventDetails
{
string ObjectName { get; set;}
DateTime? StartDate { get; set;}
DateTime? EndDate { get; set;}
}
The Data Transfer Object is created from a class that implements IEventDetails.
Following is the structure of IEventdetails:
|
Property Name |
Description |
Data Type |
|
ObjectName |
The object name that is in the database. For example: Dimension_001 in the BI Gateway Server |
String |
|
StartDate |
StartDateTime of event in UTC |
DateTime |
|
EndDate |
EndDateTime of event in UTC |
DateTime |
Important: Make sure that the Start DateTime and End DateTime parameter is in UTC date and time format.
Return Value:
A GUID is returned corresponding to the event created in the database. If the AddDimensionDateRangeEvent () method fails, an error is logged in the ArchestrA Logger and a value of zero is returned.
Postman Example
The following Postman code snippet shows the example for the query.
{"ObjectName":"Dimension_001","StartDate":"2021-01-02 08:00:00Z","EndDate":"2021-01-03 23:59:59Z"}
If the query is successful, the relevant GUID is displayed as a response.