We are deprecating selected endpoint versions in the Dalux FM API and replacing them with newer versions.
To ensure your integration continues to function correctly after these changes, please review and complete the following actions:
- Update to the latest API endpoint versions
- Review and update any property fields with history enabled (user-defined fields and asset properties)
Update API
If you are using any of the old or earlier versions, you will need to update to the corresponding new versions shown below.
Locations
| Old (will be deprecated) | New |
| POST /2.0/estates | POST /3.0/estates |
| PATCH /2.0/estates/{estateId} | PATCH /3.0/estates/{estateId} |
| POST /2.0/buildings | POST /3.0/buildings |
| PATCH /2.0/buildings/{buildingId} | PATCH /3.0/buildings/{buildingId} |
| POST /2.1/lots | POST /3.0/lots |
| PATCH /2.1/lots/{lotId} | PATCH /3.0/lots/{lotId} |
| PATCH /2.0/rooms/{roomId} | PATCH /3.0/rooms/{roomId} |
Assets/Products
| Old (will be deprecated) | New |
| POST /2.0/assets | POST /3.0/assets |
| PATCH /2.0/assets/{assetId} | PATCH /3.0/assets/{assetId} |
| POST /2.0/products | POST /3.0/products |
| PATCH /2.0/products/{productId} | PATCH /3.0/products/{productId} |
Fields with history enabled
With the new endpoints it will no longer be possible to POST or PATCH request changes to user-defined fields, if the history setting on the field is set to “Enabled“ for properties under Assets and User fields.
Note
Please note that once the setting for history is set, it cannot be edited again - this means that you will need to create new fields with the setting disabled, for all objects you are API POST and PATCH requesting, making sure that the API requests can continue to work unhindered. See below for details.
The setting for history in Dalux FM is accessed on the individual fields here (example for user defined fields for Rooms):
Read more about user defined fields in our HelpCenter here: Custom user fields
The change also applies for Assets endpoints, the properties history setting is set here:
Read more about properties for Assets in our HelpCenter here: Asset classifications and properties in FM
Procedure for fields with history enabled.
If any of your fields have history enabled, they will not work with the updated API endpoints. To resolve this, you will need to export the existing data, delete the fields, recreate them with history disabled, and then re-import the data.
- Create new fields with history set to Disabled
- Export and import all data from the old fields to the new ones
- Update data integrations that either write to or read from these fields
- Update all places in Dalux FM where these user-defined fields are used (e.g. in asset templates or similar)