|Maintenance Notice - PDF Generation|
|Dynamic PDF generation for web-based content is temporarily unavailable. This maintenance affects dynamic PDF files that are generated from either the HTML-based page or manual that you are viewing. Links that normally allow this functionality have been hidden, and will reappear as soon as the feature is restored.
Genesys Rules System REST API Reference Guide
The GRS REST API provides functions to manage:
- Authentication—login, logout.
- Business Hierarchy
- Rule Templates
- Rule Packages
- Business Calendars
- Deployments and Snapshots
Applications or custom user interfaces (which can run in parallel to or instead of the Genesys Rules Authoring Tool web application) can use this API to perform rule authoring and deployment.
This reference can be used to write applications that use the Genesys Rules System Representational state transfer (REST) Application Programming Interface (API). This reference also explains the resources and methods available to developers. Each category presents information about relevant operations, related resources, request parameters, and return values.
Enabling/Disabling the GRS REST API
Use of the API can be enabled or disabled by setting the value of configuration option rest-api. In addition, this configuration option will enable you to determine whether or not to force only SSL communications. Genesys strongly recommends running over SSL in order to protect the authentication tokens that flow on each request from compromise. SSL can be disabled where appropriate (for example, testing labs, positioning server behind firewalls, and so on). Valid values are as follows:
- disabled—(default)The REST API is disabled and will not accept any requests.
- enabled—The REST API is enabled and will accept both secure (https) and non-secure (http) requests.
- requireSSL—The REST API is enabled and will only accept secure (https) requests.
In this release, the REST API will be available only from the Tomcat application server.