SearchFilterView

dataRequestedDatestring<date>

Filter data of objects that are valid at this date (included).

Example: 2023-10-25

dataValidFromstring<date>

Filter data of objects that are valid until this date (included).

Example: 2024-10-25

documentTypestringdeprecated

Deprecated

holderCodesstring[]

ERP codes of holders when requesting for specific assets or contracts

Example: ["ABC","DEF"]

requestedBuildingCodestring

Only used when requesting contracts. Filter contracts that belongs to given building.

Example: ABC

requestedDatestring<date>

Filter objects that are valid starting from this date (included). For assets, effective date. For contracts, effective date.

Example: 2023-10-25

requestedPropertyCodesstring[]

Request data of given types. If not filled, no data is returned.

Example: ["ELECTRICITY_CONSUMPTION"]

sort object

Filled from query param.

fieldOrder object

property name*string

validUntilstring<date>

Filter objects that are valid until this date (included). For assets, expiration date. For contracts, termination date.

Example: 2024-10-25

SearchFilterView

{
  "dataRequestedDate": "2023-10-25",
  "dataValidFrom": "2024-10-25",
  "holderCodes": [
    "ABC",
    "DEF"
  ],
  "requestedBuildingCode": "ABC",
  "requestedDate": "2023-10-25",
  "requestedPropertyCodes": [
    "ELECTRICITY_CONSUMPTION"
  ],
  "sort": {
    "code": "ASCENDING"
  },
  "validUntil": "2024-10-25"
}