Dataset Date Parameters

Guidelines on DataAccess API date duration parameters to ensure that the datasets that are defined work correctly on Dashboard Application Services Hub.

For DataAccess API, all APIs need date duration parameters. Hence all the datasets must define the three parameters; startDate, endDate, and Duration. These parameters are optional as you can give none or exclude one or more values from the three parameters.

See the table to know the supported and non-supported parameters and their combinations:
  • Valid usage
 Support Dataset behavior
  • StartDate
  • EndDate
 Supported Start date and end date validation
Future start date selection validation
If no violation then data is shown for start and end date that are given.
  • StartDate
  • Duration
 Supported Start date and end date validation
Future start date selection validation
End date calculation, and if no violation then data is shown for start and end date that are given.
  • StartDate
  • EndDate
  • Duration
 Supported Ignores duration.
Start date and end date validation
Future start date selection validation
If no violation then data is shown from start to end date.
  • If no values are provided
 Supported Data is shown for current date 12 midnight to current time.
  • StartDate
 Not supported Error message is shown for wrong parameter combination.
  • Duration
 Not supported Error message is shown for wrong parameter combination.
  • EndDate
 Not supported Error message is shown for wrong parameter combination.
  • Duration
  • EndTime
Not supported Error message is shown for wrong parameter combination.