Breaking Changes

In general, we try to deploy API changes in a non-breaking way. If this is not possible, you'll find all necessary and vital information on this page. The following breaking changes are incompatible changes we had to deploy into operation, and therefore you - as a user of our API - need to be aware of them and take action accordingly.

Version 2.0 (as of 13th December 2019)

Renaming of system properties from "enaio" to "system"

The API comes with a personal, tenant-specific schema, which consists of unchangeable system properties, and the global schema. It determines the attributes and properties that objects must or may have. Our system properties have been renamed from "enaio" to "system".

Example: System properties enaio:objectId, enaio:createdBy and enaio:creationDate have been renamed to system:objectId, system:createdBy and system:creationDate.

Action: Please update all used system properties accordingly in your sources.

→ Schema Definition

Schema version has been updated to 5.0

Your personal, tenant-specific schema, consists of unchangeable system properties, and the global schema. It determines the attributes and properties that objects must or may have. You can retrieve your schema by sending a GET request to the URL /admin/schema ("Get the raw tenant schema" endpoint) and bring in your schema modifications update using POST request to the URL /admin/schema ("Update the tenant schema" endpoint). Note that the schema's version has been modified from 4.0 to 5.0.

<schema xmlns="http://optimal-systems.org/ns/dmscloud/schema/v5.0/" ...

Action: If you are going to update a schema, make sure that you use the new version number 5.0.

→ Schema Definition