FilterRequest

A FilterRequest típusok olyan típusok, amelyeket szűrési feltételek szerinti lekérdezésre szolgáló, ún. filterező műveletek várnak a request body-ban.

Ilyen műveletek például:

• Find Number Blocks By Filter
• Find Sales Invoices By Filter

A filterező műveletek az alábbiakat támogatják:

• Entitások szűrése feltételek szerint, azaz csak azokat az entitásokat adja vissza, amelyek megfelelnek a megadott szűrők mindegyikének.
• Entitások rendezése valamilyen tulajdonsága szerint.
• A találatok lapozása.

A FilterRequest típusok mezői:

• filter: a szűrőfeltételek, típusa a lekérdezendő entitástól függ
• order: a rendezés, mezői: 
  • by
    • az entitás tulajdonsága, amely szerint rendezzük az eredményeket
    • mindig enum típusú
    • pl. "CREATED_ON"
  • reverse
    • boolean típusú
    • a true fordított rendezést jelent, azaz a true az SQL ASC, a false a DESC kulcsszavának felel meg
    • ha nincs megadva, akkor nincs fordított rendezés
• page: lapozás, mezői:
  • size: A kért lap mérete. Pozitív egész szám.
  • index: A lapozás nullától sorszámozott kezdőindexe. Nemnegatív egész szám.
  • Sem a size, sem az index mező nem kötelező, de vagy mindkettőt meg kell adni, vagy egyiket sem.

Példa:

{
  "filter": {
    ...
  },
  "page": {
    "size": 10,
    "index": 0
  },
  "order": {
    "by": "ISSUE_DATE",
    "reverse": false
  }
}