Skip to main content

DataSetQueryCriteriaTimePeriods

The time period criteria to filter results by in a data set query.

Properties

Property Type Required Description
eq DataSetQueryTimePeriod false

Filter the results to be in this time period.
notEq DataSetQueryTimePeriod false

Filter the results to not be in this time period.
in array (DataSetQueryTimePeriod) false

Filter the results to be in one of these time periods.
notIn array (DataSetQueryTimePeriod) false

Filter the results to not be in one of these time periods.
gt DataSetQueryTimePeriod false

Filter the results to be in a time period that is chronologically greater than the one specified.
gte DataSetQueryTimePeriod false

Filter the results to be in a time period that is chronologically greater than or equal to the one specified.
lt DataSetQueryTimePeriod false

Filter the results to be in a time period that is chronologically less than the one specified.
lte DataSetQueryTimePeriod false

Filter the results to be in a time period that is chronologically less than or equal to the one specified.

Example schema

{
  "eq": {
    "period": "2020/2021",
    "code": "AY"
  },
  "notEq": {
    "period": "2020/2021",
    "code": "AY"
  },
  "in": [
    {
      "period": "2020/2021",
      "code": "AY"
    }
  ],
  "notIn": [
    {
      "period": "2020/2021",
      "code": "AY"
    }
  ],
  "gt": {
    "period": "2020/2021",
    "code": "AY"
  },
  "gte": {
    "period": "2020/2021",
    "code": "AY"
  },
  "lt": {
    "period": "2020/2021",
    "code": "AY"
  },
  "lte": {
    "period": "2020/2021",
    "code": "AY"
  }
}