...
Operator Label | Positive Operator Name |
Equals | eq, = |
notEquals | ne, != |
Contains | c |
Starts With | sw |
Ends With | ew |
In | in |
Less Than | lt, > |
Greater Than | gt, < |
Less Than Equals | lte, >= |
Greater Than Equalsgte | get, <= |
Between | btw |
Match | mt |
All Of | all |
Any Of | any |
None Of | none |
Exactly | exactly |
during | during |
Period Component Query
To filter the records of an object for a particular duration e.g. for days, weeks, months, years, financial years, etc.
Period types are as follows:The period Component query is only applicable for Date and DateTime fields.
The operators used in period component query are as follows
equals
current
next
currentAndNext
during
The period units used in period component query are as follows
days: n
If conditions: { createdOnperiodUnit: " days, periodCount: 'n"'}
It will return the records which are created between the current date to 'n' days
If conditions: { createdOnperiodUnit: " days, periodCount: -'n"'}
It will return the records which are created from the 'n' days prior to the current date
weeks: n
If conditions: { createdOn: "weeks:n"}
It will return the records which are created between the current week to 'n' weeks
If conditions: { createdOn: "weeks:-n"}
It will return the records which are created from the 'n' weeks prior to the current week
months: n
If conditions: { createdOn: "weeks:n"}
It will return the records which are created between the current month to 'n' months
If conditions: { createdOn: "weeks:-n"}
It will return the records which are created from the 'n' months prior to the current month
calQuarters: n (calendar quarter)
If conditions: { createdOn: "calQuarters:n"}
It will return the records which are created between the current calendar quarter to 'n' calendar quarters
If conditions: { createdOn: "calQuarters:n"}
It will return the records which are created from the 'n' calendar quarter prior to the current calendar quarter till the current calendar quarter
fYQuarters: n (financial quatrer)
If conditions: { createdOn: "fYQuarters:n"}
It will return the records which are created between the current financial quarter to 'n' financial quarters
If conditions: { createdOn: "fYQuarters:n"}
It will return the records which are created from the 'n' financial quarter prior to the current financial quarter till the current financial quarter
calYears: n (current calendar year)
If conditions: { createdOn: "calYears:n"}
It will return the records which are created between the current calendar year to 'n' calendar years
If conditions: { createdOn: "calYears:n"}
It will return the records which are created from the 'n' calendar year prior to the current calendar year till the current calendar year
fYYears: n (current financial year)
If conditions: { createdOn: "fYYears:n"}
It will return the records which are created between the current financial year to 'n' financial years
If conditions: { createdOn: "fYYears:n"}
It will return the records which are created from the 'n' financial year prior to the current financial year till the current financial year
During Operator
During means some time between the beginning and the end of a period
The during operator of the period component query is applicable for the Date and DateTime fields
Relative Literals in period component query
Yesterday
If condition{ period: ”yesterday”}
It will return the previous day's record from the current day
If condition{ period: ”tomorrow”}
It will return the next day's record from the current day
If condition{ period: ”today”}
It will return the current day record
If condition{ period: ”next7Days”}
It will return the next 7 day's records from the current day
If condition{ period: ”next30Days”}
It will return the next 30 day's records from the current day
If condition{ period: ”next60Days”}
It will return the next 60 day's records from the current day
If condition{ period: ”next90Days”}
It will return the next 90 day's records from the current day
If condition{ period: ”next180Days”}
It will return the next 180 day's records from the current day
If condition{ period: ”previous7Days”}
It will return the previous 7 day's records from the current day
If condition{ period: ”previous30Days”}
It will return the previous 30 day's records from the current day
If condition{ period: ”previous60Days”}
It will return the previous 60 day's records from the current day
If condition{ period: ”previous90Days”}
It will return the previous 90 day's records from the current day
If condition{ period: ”previous180Days”}
It will return the previous 180 day's records from the current day
If condition{period: “currentWeek”}
It will return the current week records
If condition {period: “nextWeek”}
It will return the next week records from the current week
If condition {period: “previousWeek}
It will return the previous week records from the current week
If condition {period: “currentAndNextWeek”}
It will return the next week and the current week records
If condition {period: “currentAndPreviousWeek}
It will return the previous week and the current week's’s records
If condition{period: “currentMonth”}
It will return the current month records
If condition {period: “nextMonth”}
It will return the next month records from the current month
If condition {period: “previousMonth}
It will return the previous month records from the current month
If condition {period: “currentAndNextMonth”}
It will return the next month and the current month records
If condition {period: “currentAndPreviousMonth}
It will return the previous month and the current month records
If condition{period: “currentCalendarQuarter”}
It will return the current calendar quarter records
If condition {period: “nextCalendarQuarter”}
It will return the next calendar quarter records from the current calendar quarter
If condition {period: “previousCalendarQuarter}
It will return the previous calendar quarter records from the current calendar quarter
If condition {period: “currentAndNextCalendarQuarter”}
It will return the next calendar quarter and the current calendar quarter records
If condition {period: “currentAndPreviousCalendarQuarter}
It will return the previous calendar quarter and the current calendar quarter records
If condition{period: “currentCalendarYear”}
It will return the current calendar year records
If condition {period: “nextCalendarYear”}
It will return the next calendar year records from the current calendar year
If condition {period: “previousCalendarYear}
It will return the previous calendar year records from the current calendar year
If condition {period: “currentAndNextCalendarYear”}
It will return the next calendar year and the current calendar year records
If condition {period: “currentAndPreviousCalendarYear}
It will return the previous calendar year and the current calendar year records