Configuring Date Parameters

You can configure the URL of the API request with templates containing date queries. The queries will be updated with respective date values.

Syntax{{:today()}}:It is used for single calendar related method.

Or

Syntax{{:today().adddays(1)}}:It is used when more than one method is added.

For example,a dummy API is used to explain here

Now, this URL will be parsed, and templates will be matched, hence the templates will be replaced with dates accordingly. This helps you to fetch data between the start date and end date.

Functions supported in date parameters

You can configure parameters as numeric values for the following functions: AddMinutes, Addhours, AddDays, AddWeeks, AddMonths, AddYears, AddQuarters, SetDayStart, and SetMonthStart.

All the Add methods should not have parameter as 0, the SetDayStart should have a numerical value between 0 and 6, and the SetMonthStart should have a numerical value between 1 and 12.

String parameters are used in the next set of functions which are start, end, format, and SetTimeZone. Both start and end functions support four string parameters which are week, month, quarter, and year. The format function is used to change the format of date and time, and the parameter is matched with the date and time format supported in C#. A support for epoch time is also made available in the format function. The SetTimeZone is used to change the time zone of the date and the parameter is matched with TimeZoneInfo IDs present in C#.

Today function does not hold any parameters.
Here for example concern we are using today()as 11/16/2018 12:17

Function Name	Type(s) Used	Description	Example(s)	Result
Today	No Parameter	Sets date and time to current date and time.	{{:today()}}	11/16/2018 12:17
AddMinutes	Numerical	Updates the date and time by changing the number of minutes.	{{:today().addminutes(10)}}	11/16/2018 12:27
AddHours	Numerical	Updates the date and time by changing the number of hours.	{{:today().addminutes.addhours(2)}}	11/16/2018 14:29
AddDays	Numerical	Updates the date and time by changing the number of days.	{{:today().adddays(2)}}	11/18/2018 12:17
AddWeeks	Numerical	Updates the date time by adding a date with the numerical parameter considered as 7 days.	{{:today().addweeks(1)}}	11/23/2018 12:17
AddMonths	Numerical	Updates date and time by adding months with numerical parameter.	{{:today().addmonths(2)}}	1/16/2018 12:17
AddYears	Numerical	Updates date and time by adding years with the numerical parameter.	{{:today().addyears(3)}}	11/16/2020 12:17
AddQuarters	Numerical	Updates date and time by adding months with a numerical parameter, where parameter value 1 means 3 months.	{{:today().adddays(10).addquarters(2)}}	5/26/2019 12:17
Start	String	Sets the date and time values to the start of the given string parameter.	{{:today.addweeks(2).start(week)}}	11/25/2018 00:00
End	String	Sets the date and time value to the end of the given string parameter.	{{:today().addmonths(4).end(year)}}	12/31/2019 00:00
Format	String	Formats the date and time to the correct date format entered as string parameter.	{{:today().start(week).format(MM/dd/yyyy)}}	11/11/2018
SetTimeZone	String	Changes the time zone to the time zone entered as string parameter.	{{:today().settimezone(New Zealand Time Zone)}}	11/16/2018 19:47
SetDayStart	Numerical	Updates the date to the day of the week based on the entered numerical parameter.	{{:today().Setdaystart(1)}}	11/12/2018 12:17
SetMonthStart	Numerical	Updates the date to change the month based on the entered numerical parameter	{{:today().SetMonthStart(10)}}	10/16/2018 12:17

NOTE

Each template should mandatorily start with today function.
For a template, if the format function is used, it should be the last function call.