AddDimensionDateRangeEvent() method

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 service to reprocess the time slices of the date range.

URL: https://<BI Gateway URL>/eventapi/odata/Event/AddDimensionDateRangeEvent

For example: https://eu.v2.bigateway.connect.aveva.com/eventapi/odata/Event/AddDimensionDateRangeEvent

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

Important: Make sure that the Start DateTime and End DateTime parameter are 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 Application Insight and a value of zero is returned.

Postman example

The following Postman code snippet shows the example for the query.

Note: Replace the values for ObjectName, Dimension, StartDate, and EndDate according to your requirement.

{"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.

For more information about Postman installation and configuration, see Configuring Postman Settings.

Delete aaIDs in Postman

Within a Postman query, you can delete aaIDs before an entry process. The aaID is presented in the dimension column.

The following is an example query used in Postman to delete aaIDs:

{

"ObjectName": "Dimension_001",

"aaIDs": [

"4",

"5"

],

"StartDate": "2023-03-18 23:24:00.000",

"EndDate": "2023-03-19 02:12:00.000"

}

Note: The option to delete aaIDs is optional.

Deletion of the aaID will not be processed if:

• the aaID does not fall within the date range specified in the query.

• the aaID provided is irrelevant or does not exist.

• you provide multiple aaIDs and only some fall in the specified date range.