Case Management API
The Case management module allows organizations to report all kind of cases (think of complaints, incidents, deviations, projects, improvement measures and so on) using customizable forms. After a case has been reported, it goes through a workflow, which is customizable per case type.
For example: a workflow can be configured to make sure that the correct people are informed when a complaint is received, and that the complaint is handled according to the organization’s compliant policy.
In addition, the module contains tools which can be used to perform root cause analysis on cases (mainly used for incident investigation).
This module is licensed under the name Zenya FLOW although some customers might still refer to it by its old name iTask.
The API for this module covers automated creation of cases, manipulation of existing cases, and retrieval of information about existing cases.
It also allows to perform certain application management tasks in an automated fashion.
Searching for – and retrieving lists of – forms which can be filled out is possible via API’s which operate on portals or collections. The purpose of the portals and collections is discussed further on in this document. The purpose of the portals and collections is discussed further in this document.
The REST API for case management can be used to accomplish the scenario’s listed below:
- Use the cases route to create a new case, for more information check out our REST examples on GitHub (see link below).
- Use the mobile_forms route to retrieve the list of available mobile forms.
In addition you can retrieve the design of the mobile form. The design contains all available fields and conditions.
- Use the case_types route to retrieve information about the case types including information about their fields
- Keyword extraction can be applied to natural text appearing in case forms.
Use the keywords route to retrieve and manipulate keywords.
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.