API
TrainingSupportCommunity

time

  • Property Manager name: Time Interval
  • Criteria version: The v2024-10-21 rule format supports the time criteria v1.1.
  • Rule format status: GA, stable
  • Access: Read/Write
  • Allowed in includes: Yes

Specifies ranges of times during which the request occurred.

OptionTypeDescriptionRequires
match​Operatorenum

Specifies how to define the range of time.

{"displayType":"enum","options":["BEGINNING","BETWEEN","LASTING","REPEATING"],"tag":"select"}
BEGINNING
The duration is indefinite, using the value of begin​Date.
BETWEEN
Sets a single range between two dates, using the values of begin​Date and end​Date.
LASTING
Sets a single range, but based on duration relative to the starting time. It relies on the values of lasting​Date and lasting​Duration.
REPEATING
Allows a LASTING-style range to repeat at regular intervals. It relies on the values of repeat​Begin​Date, repeat​Duration, and repeat​Interval.
repeat​Intervalstring (duration)
Sets the time between each repeating time period's starting points.
match​Operator is REPEATING
{"displayType":"string","tag":"input","type":"text"}
{"if":{"attribute":"matchOperator","op":"eq","value":"REPEATING"}}
repeat​Durationstring (duration)
Sets the duration of each repeating time period.
match​Operator is REPEATING
{"displayType":"string","tag":"input","type":"text"}
{"if":{"attribute":"matchOperator","op":"eq","value":"REPEATING"}}
lasting​Durationstring (duration)
Specifies the end of a time period as a duration relative to the lasting​Date.
match​Operator is LASTING
{"displayType":"string","tag":"input","type":"text"}
{"if":{"attribute":"matchOperator","op":"eq","value":"LASTING"}}
lasting​Datestring (timestamp)
Sets the start of a fixed time period.
match​Operator is LASTING
{"displayType":"string","tag":"input","type":"datetime-local"}
{"if":{"attribute":"matchOperator","op":"eq","value":"LASTING"}}
repeat​Begin​Datestring (timestamp)
Sets the start of the initial time period.
match​Operator is REPEATING
{"displayType":"string","tag":"input","type":"datetime-local"}
{"if":{"attribute":"matchOperator","op":"eq","value":"REPEATING"}}
apply​Daylight​Savings​Timeboolean 
Adjusts the start time plus repeat interval to account for daylight saving time. Applies when the current time and the start time use different systems, daylight and standard, and the two values are in conflict.
match​Operator is REPEATING
{"displayType":"boolean","tag":"input","type":"checkbox"}
{"if":{"attribute":"matchOperator","op":"eq","value":"REPEATING"}}
begin​Datestring (timestamp)
Sets the start of a time period.
match​Operator is BEGINNING
OR match​Operator is BETWEEN
{"displayType":"string","tag":"input","type":"datetime-local"}
{"if":{"op":"or","params":[{"attribute":"matchOperator","op":"eq","value":"BEGINNING"},{"attribute":"matchOperator","op":"eq","value":"BETWEEN"}]}}
end​Datestring (timestamp)
Sets the end of a fixed time period.
match​Operator is BETWEEN
{"displayType":"string","tag":"input","type":"datetime-local"}
{"if":{"attribute":"matchOperator","op":"eq","value":"BETWEEN"}}