Status
Tech review

Style guide




Short description

Returns the week of a year.

Output

Available since




This function returns a number representing the week of the year of a given date in a certain time zone.


weekOfTheYear(timestamp, firstDayOfTheWeek, minimalDaysInFirstWeek, timeZone) #Output: Number



Parser expressionDescription


weekOfTheYear(2023/01/03, {SUNDAY}, 1, LOCAL)


This example returns: 1


weekOfTheYear(2023/01/03, {MONDAY}, 1, LOCAL)


This example returns: 2


weekOfTheYear({issue.created}, {MONDAY}, 7, LOCAL)


This example might return 20 if the issue was created in week 20.



Parameters used in this function

ParameterInput (data type)Description
timestamp

The parameter must be valid timestamp. Usually this value is retrieved from a field (e.g. due date, created date).
firstDayOfTheWeek

The first day of the week, e.g.: {SUNDAY} in the U.S., and {MONDAY} in Germany. Both values are time macros.
minimalDaysInFirstWeek

The minimal number of days required in the first week of the year, e.g., if the first week is defined as the one that contains the first day of the first month of the year, value 1 should be used.

If the minimal number of days required must be a full week (e.g. all days of the week need to be in that year), value 7 should be used.

timeZone

The time zone used for the calculation. 


Days might depend on the time zone - it might be Sunday on the west coast of the US while at the same time it's already Monday in Australia. 



This function returns a