skip to main content
Corticon Server: Integration & Deployment Guide : Corticon API reference : REST Management API : Summary of REST methods for management of Decision Services
 

Try Corticon Now
Summary of REST methods for management of Decision Services

Summary of REST methods for management of Corticon Servers and Decision Services

Method
Type
Syntax and function
HTTP GET
<base>/decisionService/list
Returns a list of Decision Services deployed on the server. The resulting payload will be enclosed in the response's body in JSON object form.
HTTP POST
<base>/decisionService/deploy
Attempts to add a Decision Service to the server. Request objects will be sent as the content.
HTTP POST
<base>/decisionService/undeploy
Attempts to remove the Decision Service from the server and delete the EDS file associated with it. The request will take HTTP headers that provides the Decision Service name, and, optionally the Major and Minor version Number.
HTTP GET
<base>/decisionService/getProperties
Returns the properties pertaining to the Decision Service. The request gets the properties for the Decision Service passed in its header. The request will take HTTP headers that provide the Decision Service name, and, optionally the Major and Minor version Number.
HTTP POST
<base>/decisionService/setProperties
Attempts to modify the properties of a specified Decision Service.
HTTP GET
<base>/server/ping
Returns an object containing the current uptime of the server, which confirms that the server is reachable and running.
HTTP POST
<base>/server/metrics
Retrieves metrics for the server. The request can pass in a Decision Service (or a list of Decision Services as an array), and a timestamp showing when the windowed metrics will begin. If the JSON object does not contain any Decision Service, metrics are returned for all the Decision Services in the server along with the server metrics.
HTTP GET
<base>/server/info
Returns information about the server. The returned object will contain information about both the server and the Decision Services deployed on the server.
HTTP GET
<base>/server/log
Returns the server log entries after the specified timestamp.
HTTP GET
<base>/server/getProperties
Returns the properties pertaining to the server. The returned object will be a list of key/value pairs consisting of key: propertyName value: value with information about the property.
HTTP POST
<base>/server/setProperties
Sets properties on the server using a JSON object. The object will contain a key/value format system: propertyName value: value intended to be set for this property.
HTTP POST
<base>/server/setLicense
Sets the license file for the server. This can be used to add a license in the event the current one is not usable.
* API ListDecisionServices
* API Deploy Decision Service
* API Undeploy Decision Service
* API Get Decision Service Properties
* API Set Decision Service Properties
* API Ping Server
* API Retrieve Metrics
* API Get Server Log
* API Get Server Info
* API Get Server Properties
* API Set Server Properties
* API Set Server License