Browse content API
iProva allows users to browse through content which is available to them (for users which prefer browsing over searching).
Content available to the user might include:
- Documents
- Process flowcharts
- Cards
- Forms
- Question list
- Reports (management information)
- Links to web pages/network locations
Of course, it would not make sense to present a list of all content in iProva – since this will typically result in thousands of items.
Therefore, lists can be limited to the scope of a certain portal or to an even smaller scope: collections. The concepts “portals” and “collections” are explained in this document.
In addition, filtering of results on metadata criteria is also possible.
For example, this allows you to show a list of only Word documents, or only documents which were published in the last month.
Available API’s
The REST API and WCF API give access to the content of portals and collections. They can be used to retrieve lists of content. Results are automatically security trimmed (only results which are accessible to the user will be included). For each result, an URL is returned which can be used to redirect the user to the iProva screen in which the actual content will be shown.
The WCF API also supports filtering.
The REST API for content_items and portals can be used to accomplish the scenario’s listed below:
- Retrieve information about portals and collections
- Retrieve lists of content items present in a portal or collection
General API usage information
Overview of important information for consumers of the iProva REST API, with topics like versioning, verbs, status codes, authentication and error handling.
Change log
Overview of changes and announced deprecations regarding the iProva REST API.
Examples
Our code samples on GitHub show you how to get started with the iProva REST API.
API Reference
A detailed reference for this API is provided in Swagger format.
Please note that the Swagger reference is also present in each customer’s iProva tenant. You can find it by adding /api to the URL of the customer’s iProva tenant. For example: https://organisation.iprova.nl/api
In order to interact with the Swagger reference, you need to access the Swagger in the customer’s iProva, and you need valid credentials for the customer’s iProva.