Migrate from v1 to v2

In order to provide a better and more fine grain security model, it is no longer possible to generate API-Keys for version 1 of the MindKey Connector API. We strongly recommend to migrate to version 2.

Changes to entities

The following relations have be removed and are now provided as a dedicated entity:

v1	v2	required scope	remarks
Employee.dependants	EmployeeDependant	EmployeeData
Employee.position	PositionVersion	Organization	A simplified version is still present on Employee
Employee.equipments	EmployeeEquipment	EmployeeData
Employee.userDefinedColumns	EmployeeUserDefinedColumn	EmployeeData

All entities not have a relation to a simple employee and/or position object, making basic employee and position data available

Migration guide

For most of the simple use cases we can see, the migration is as follow:

• Generate a new API-Key with the appropriated scopes.
• Change v1 to v2 in the url.

If your query is working, you have successfully migrated to version 2. For queries that use on of the removed relations, the query must be change.

Example: Migrating Employee.UserDefinedColumns

Query in v1:

GET https://connector.mindkey.com/odata/v1/Employee?
    $expand=userDefinedColumns($filter=userDefinedColumnId eq 'Some Id' or userDefinedColumnId eq 'Some other Id')
    &$select=employeeId,userDefinedColumns

Query in v2:

GET https://connector.mindkey.com/odata/v2/EmployeeUserDefinedColumn?
    $expand=employee($select=employeeId)
    &$filter=userDefinedColumnId eq 'Some Id' or userDefinedColumnId eq 'Some other Id'

Remarks:

• Those two queries are not equal. V1 was a "left join" while V2 is an "inner join"
• The structure of the response is different

Support

If you have any questions regarding the migration from v1 to v2, please contact our support.