Qorus Integration Engine® Enterprise Edition 6.0.27_prod
|
Qorus implements two network-available system APIs:
The Qorus REST API has been implemented to use REST design principles for interfacing with Qorus Integration Engine.
The Qorus REST API follows the following REST design principles:
GET
requests never make changes (do not alter state)PUT
requests can change server state and are also idempotentPOST
requests create new objects or configurationDELETE
requests delete existing objects or configurationQorus's REST API is designed to facilitate data exchanges between clients and the server. Serialized data is supported with the following Content-Types
(clients indicate support by including these in the Accept
header):
text/x-yaml
or application/x-yaml
: YAMLapplication/json
: JSONtext/xml
: XML-RPC (for HTTP payload body encoding)text/html
: HTML (for responses only)The REST API is accessible from the Qorus HTTP server anchored at the path "/api"
; the latest version of the REST API is accessible at "/api/latest"
; see the following section for more information.
There are two methods of calling the API. Both methods are identical. Examples:
PUT foo/bar?action=myAction
PUT foo/bar/myAction
Accept
header is present, then it is assumed that the client accepts all media types; see http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html"/api/latest"
URI path prefix to requests to Qorus.The following header can be given by clients to specify the client's time zone region:
Qorus-Client-Time-Zone
For example:
Qorus-Client-Time-Zone: America/New_York
This allows the REST server to handle date/time values in the client's time zone.
The REST API is versioned in order to provide maximum backwards-compatibility to external applications and allow for maximum flexibility for future expansion.
Each REST API version besides the base version (version 1) is accessible with a URI prefix with its version name as follows:
The following URI prefix can be used to ensure that the latest version of the REST API is used at all times: