Dé beste software voor kwaliteits- en risicomanagement.

Front-end for end users

My tasks

All Zenya modules generate tasks and/or notifications for users. Tasks require the user to take action. Notifications are informational.

Available API’s

A REST API is available for federated search. It supports searching in specific scopes. Search 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 Zenya screen in which the actual content will be shown.
An older API based on WCF is also still available for federated search, but is deprecated and will loose support in Q2 2022.

A WCF API is present to support content crawling in the specific manner required by SharePoint (on-premise) external content types.
For other systems which want to perform content crawling, we advise to use the REST API.

REST API
WCF API
SOAP API
  • Use the tasks route to retrieve the list of tasks for a user.
  • Use the notification route to retrieve the list of notifications for a user.
  • Use the tasks route to interact with tasks which support it.
    In general, tasks which contain action links cannot be completed via the API. The action link has to be presented to the user, and the task will automatically be completed when user performs the action which the link leads him to.

    Note that tasks and notifications can be retrieved for a person, but also for a team.

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.

Change log
Overview of changes and announced deprecations regarding the Zenya REST API.

Examples
Our code samples on GitHub show you how to get started with the Zenya 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 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.

The WCF API for My Tasks can be used to accomplish the scenario’s listed below:

  • Retrieve a list of tasks assigned to a user,
    to display it (for example) in an intranet widget
  • Retrieve the number of tasks assigned to a user

This API is deprecated and is planned for removal in Q2 2022. Use the REST API instead.

General API usage information
Overview of important information for consumers of the Zenya WCF API, with topics like authentication.

Change log
Overview of changes and announced deprecations regarding this API.

API Reference
A detailed reference for this API is provided in PDF format.

The SOAP API for My Tasks can be used to accomplish the scenario’s listed below:

  • Retrieve a list of tasks assigned to a user,
    to display it (for example) in an intranet widget
  • Retrieve the number of tasks assigned to a user

This API is deprecated and is planned for removal in Q2 2022. Use the REST API instead.

General API usage information
Overview of important information for consumers of the Zenya SOAP API, with topics like authentication.

Change log
Overview of changes and announced deprecations regarding this API.

API Reference
A detailed reference for this API is provided in PDF format.