Home Schema Example JSON Schema

Filter Settings

Type: object

Schema for storing filter settings.

 No Additional Properties

root type

Type

Type: const

The type of this element.

Specific value: "expression"

root expression

Expression

Type: object

Expression of filter.

 No Additional Properties

root expression operator

Operator


Operator of expressions.

root expression operator oneOf item 0
Type: object
No Additional Properties

root expression operator oneOf item 0 type

Type

Type: enum (of string)

The type of this element.

Must be one of:

  • "and"
  • "or"
  • "not"
root expression operator oneOf item 1
Type: object
No Additional Properties

root expression operator oneOf item 1 type

Type

Type: const

The type of this element.

Specific value: "at_least"

root expression operator oneOf item 1 at_least

At least

Type: object

An operator that filters any data where at least N of the conditions are true

 No Additional Properties

root expression operator oneOf item 1 at_least n

Number of data

Type: integer

Number of data where condition is true.

Value must be greater or equal to 1

root expression expressions

Expressions

Type: array

Expressions of data

 No Additional Items

Each item of this array must be:

root expression expressions expressions items

root expression expressions expressions items oneOf Filter Settings

Filter Settings

Type: object

Schema for storing filter settings.

Same definition as Filter Settings
root expression expressions expressions items oneOf item 1
Type: object
No Additional Properties

root expression expressions expressions items oneOf item 1 type

Type

Type: const

The type of this element.

Specific value: "condition"

root expression expressions expressions items oneOf item 1 condition
Type: object
No Additional Properties

root expression expressions expressions items oneOf item 1 condition type

Type

Type: const

The type of this element.

Specific value: "Q"

root expression expressions expressions items oneOf item 1 condition Q

Query


Django ORM query

 No Additional Properties

root expression expressions expressions items oneOf item 1 condition Q anyOf item 0
Type: object

The following properties are required:

  • key
  • string
root expression expressions expressions items oneOf item 1 condition Q anyOf item 1
Type: object

The following properties are required:

  • key
  • boolean
root expression expressions expressions items oneOf item 1 condition Q anyOf item 2
Type: object

The following properties are required:

  • key
  • string_array
root expression expressions expressions items oneOf item 1 condition Q anyOf item 3
Type: object

The following properties are required:

  • key
  • number
root expression expressions expressions items oneOf item 1 condition Q anyOf item 4
Type: object

The following properties are required:

  • key
  • datetime

root expression expressions expressions items oneOf item 1 condition Q key

Query key

Type: string

Must be at least 1 characters long

root expression expressions expressions items oneOf item 1 condition Q string

String

Type: string

Must be at least 1 characters long

root expression expressions expressions items oneOf item 1 condition Q number

Number

Type: integer

Value must be greater or equal to 0

root expression expressions expressions items oneOf item 1 condition Q string_array

String Array

Type: array

Must contain a minimum of 1 items

No Additional Items

root expression expressions expressions items oneOf item 1 condition Q datetime

Datetime

Type: stringFormat: date-time

root exclude

To exclude data which matches expression in filter_queryset

Type: boolean