My favorites API
Any user can mark documents (from the document management module) as a personal favorite. Favorites can be managed via the “Favorites” widget on the portal homepages in Zenya, or via the API.
A REST API is available for the retrieval of a list of favorites for the logged on user. For each favorite, an information object is returned which can be used to redirect the user to the iProva screen which allows him to view the content marked as favorite. The API also supports creating, updating, reordering and deleting the favorites.
An older API based on WCF is also still available for retrieval of favorites, but this API is deprecated and will loose support in Q2 2022.
Use the favorites route in the REST API to accomplish the scenario’s listed below:
- Retrieve the list of favorites for a user
- Create new favorite
- Remove a favorite
- Alter the text or order of a favorite
General API usage information
Overview of important information for consumers of the Zenya REST API, with topics like versioning, verbs, status codes, authentication and error handling.
Overview of changes and announced deprecations regarding the Zenya REST API.
Our code samples on GitHub show you how to get started with the Zenya REST API.
A detailed reference for this API is provided in Swagger format.
Please note that the Swagger reference is also present in each customer’s Zenya tenant. You can find it by adding /api to the URL of the customer’s Zenya tenant. For example: https://organisation.zenya.work/api
In order to interact with the Swagger reference, you need to access the Swagger in the customer’s Zenya, and you need valid credentials for the customer’s Zenya.