Optimize REST Services API
The Optimize Restful Services API contains a variety of services that enable users to query process model and process analytics data. With these services, users can extract Optimize data for use with reports and other applications. Users should be aware that use of these services can affect Optimize performance, as many of these services perform database queries. It is recommended that all implementations be tested in a production-like environment prior to release in order to understand and evaluate potential performance impacts.
Note:
Data Level Security (DLS) is not currently supported for this API.
There are two components to this API as described below.
Process Model REST API provides all the processes configured for tracking
Process Analytics REST API provides analytic data for processes.
The API returns either XML or JSON results based on request headers, as described in the following table.
type | HTTP Header “Content-Type” | HTTP Header “Accept” |
json | application/json | application/json |
xml | application/xml | application/xml |
The order of elements in the response (XML or JSON) may or may not be predefined; however, the order is subject to change and should not be relied upon when consuming the response.