DOCS API Changes
Warning
Some API changes are not backward compatible
Breaking Changes
| Path | Description |
|---|---|
GET /DOCS/Modules/{module}/Metadata/Entities/{entity}/DatabaseMappings |
Added FileContentStore to database enumeration |
Changelog
A more detailed breakdown for the individual changes can be viewed here
==========================================================================
== API CHANGE LOG ==
==========================================================================
On Key DOCS API Specification
--------------------------------------------------------------------------
-- What's New --
--------------------------------------------------------------------------
- POST /DOCS/Modules/{module}/Templates/{templateName}/Customisations/{customisationId}/Restore
- GET /DOCS/Modules/Templates/Migrations/{templateName}
- GET /DOCS/Modules/Templates/Migrations/{templateName}/Content
--------------------------------------------------------------------------
-- What's Changed --
--------------------------------------------------------------------------
- GET /DOCS/Modules/{module}/Metadata/Entities/{entity}/DatabaseMappings
Return Type:
- Changed 200 OK
Media types:
- Changed application/vnd.onkey.entitydatabasemetadata+json
Schema: Broken compatibility
- GET /DOCS/Modules/Metadata/Entities/ReportServer
Return Type:
- Changed 200 OK
Media types:
- Changed application/vnd.onkey.entitycollection+json
Schema: Backward compatible
- GET /DOCS/Modules/{module}/Templates/{templateName}/Customisations
Parameter:
- Add $select in query
- Add $filter in query
- Add $param in query
Return Type:
- Changed 200 OK
Media types:
- Changed application/vnd.onkey.entitycollectionpage+json
Schema: Backward compatible
- GET /DOCS/Modules/Metadata/Entities/UserDefinedFields
Return Type:
- Changed 200 OK
Media types:
- Changed application/vnd.onkey.entitycollection+json
Schema: Backward compatible
- GET /DOCS/Modules/Metadata/Entities/{entity}/UserDefinedFields
Return Type:
- Changed 200 OK
Media types:
- Changed application/vnd.onkey.entitycollection+json
Schema: Backward compatible
--------------------------------------------------------------------------
-- Result --
--------------------------------------------------------------------------
API changes broke backward compatibility
--------------------------------------------------------------------------