Skip to main content

RemoteDataHolderSearchFilter

allAssetsboolean

This parameter is part of authorization mechanism. Should not be filled.

Example: true
authorizedAssetCodesstring[]

This parameter is part of authorization mechanism. Should not be filled.

Example: ["ABC","DEF"]
dataRequestedDatestring

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

Example: 2023-10-25
dataValidFromstring

Filter data of objects that are valid until this date (included). Has to be used with dataValidFrom.

Example: 2024-10-25
holderCodestring

ERP code of last holder fetched for optimized search. Only works if the query is ordered by CODE DESCENDING

Example: ABC
holderCodesstring[]

ERP codes of holders when requesting for specific assets or contracts

Example: ["ABC","DEF"]
holderTypestring

Type of holder (ASSET, CONTRACT). Is detected automatically if not set.

Possible values: [ASSET, LEASE, CONTRACT, UNKNOWN]

Example: ASSET
holderTypeCodestring

Filter objects that are of given type (i.e. BUILDING, BUILDING_GROUP, LEASE).

Example: BUILDING
limitinteger<int64>

Filled from query param.

Example: 3
offsetinteger<int64>

Filled from query param.

Example: 10
organizationCodestring

Code of client. Will be filled with parameter.

Example: STONAL
requestedBuildingCodestring

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

Example: ABC
requestedDatestring

Filter objects that are valid starting from this date (included). For assets, effective date. For contracts, effective date. Has to be used with validUntil.

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

Filter objects that are valid until this date (included). For assets, expiration date. For contracts, termination date. Has to be used with validFrom.

Example: 2024-10-25
RemoteDataHolderSearchFilter
{
  "allAssets": true,
  "authorizedAssetCodes": [
    "ABC",
    "DEF"
  ],
  "dataRequestedDate": "2023-10-25",
  "dataValidFrom": "2024-10-25",
  "holderCode": "ABC",
  "holderCodes": [
    "ABC",
    "DEF"
  ],
  "holderType": "ASSET",
  "holderTypeCode": "BUILDING",
  "limit": 3,
  "offset": 10,
  "organizationCode": "STONAL",
  "requestedBuildingCode": "ABC",
  "requestedDate": "2023-10-25",
  "requestedPropertyCodes": [
    "ELECTRICITY_CONSUMPTION"
  ],
  "sort": {
    "code": "ASCENDING"
  },
  "validUntil": "2024-10-25"
}