# Corticon REST API

#### Copyright © 2005-2023 Progress Software Corporation and/or one of its subsidiaries or affiliates. All rights reserved.

## BasePath: /axis/corticon

## Methods

[ Jump to Models ]

### Table of Contents

#### BatchExecutionOperationOnBatchExecutionService

- `get /batchexecution/getIds`
- `get /batchexecution/getDetails`
- `post /batchexecution/start`
- `post /batchexecution/stop`

#### DecisionServiceExecuteDecisionService

- `post /execute`

#### DecisionServiceOperationsOnADecisionService

- `get /decisionService/getProperties`
- `get /decisionService/getVocabularyMetadata`
- `get /decisionService/list`
- `post /decisionService/deploy`
- `post /decisionService/registerMonitoredAttributes`
- `post /decisionService/reloadQueryService`
- `post /decisionService/setProperties`
- `post /decisionService/unRegisterMonitoredAttributes`
- `post /decisionService/undeploy`
- `post /decisionService/update`

#### ServerOperationsOnTheServer

- `get /server/getProperties`
- `get /server/ping`
- `post /server/setLicense`
- `post /server/setProperties`

# BatchExecutionOperationOnBatchExecutionService

Up

    get /batchexecution/getIds

Get current list of Batch Execution Ids on the CcServer. (getBatchExecutionIds)
Fetch list of all Batch Execution Ids.

### Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

- `application/json`

### Responses

#### 200

OK. Returns the list of Batch Execution Ids.

#### 204

No Content (the list is empty, the payload returns an empty JSON array)

#### 404

Not found

#### 500

Internal Server Error

Up

    get /batchexecution/getDetails

Gets Batch Execution details (getCorticonBatchExecutionDetails)
Returns the details pertaining to an already completed or currently running Batch Execution. The request gets the Batch Execution Id passed as a query parameter.

### Query parameters

id (required)
Query Parameter — The id of the Batch Execution

### Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

- `application/json`

### Responses

#### 200

OK. Get the details of the Batch Execution.

#### 400

Bad Request

#### 404

Not found

#### 500

Internal Server Error

Up

    post /batchexecution/start

Starts a Batch Execution in a CcServer (postBatchExecutionStart)
Starts Batch Execution in a CcServer based on the passed in parameters.

### Consumes

This API call consumes the following media types via the Content-Type request header:

- `application/json`

### Request body

body JSONObject - Start Batch Execution (required)
Body Parameter — JSON payload that defines all variables for the Batch Execution

### Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

- `application/json`

### Responses

#### 200

OK. Batch Execution has started.

#### 400

Bad Request

#### 404

Not found

#### 500

Internal Server Error

Up

    post /batchexecution/stop

Stops Batch Execution details (postBatchExecutionStop)
Stops a Batch Execution. The request gets the Batch Execution Id passed as a query parameter.

### Query parameters

id (required)
Query Parameter — The id of the Batch Execution

### Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

- `application/json`

### Responses

#### 200

OK. Batch Execution has started to stop all further executions.

#### 400

Bad Request

#### 404

Not found

#### 500

Internal Server Error

# DecisionServiceExecuteDecisionService

Up

    post /execute

Executes a Decision Service (postExecution)
Executes a Decision Service. The Decision Service payload is enclosed in the message body as either JSON or a XML.

### Consumes

This API call consumes the following media types via the Content-Type request header:

- `application/json`
- `application/xml`

### Request body

body Execute Decision Service (required)
Body Parameter — Payload to execute.

### Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

- `application/json`
- `application/xml`

### Responses

#### 200

OK. Executes the Decision Service.

#### 400

Bad Request

#### 404

Not found

#### 500

Internal Server Error

# DecisionServiceOperationsOnADecisionService

Up

    get /decisionService/getProperties

Gets Decision Service properties (getCorticonGetDecisionServiceProperties)
Returns the properties pertaining to the Decision Service. The request gets the properties for the Decision Service passed as a query parameter.The returned object is a list of key/value pairs consisting of key: propertyName value: JSON object with information about the property.

### Query parameters

name (required)
Query Parameter — The name of the Decision Service
majorVersion (optional)
Query Parameter — The major version of the Decision Service. This field is optional but required if minorVersion is execute.
minorVersion (optional)
Query Parameter — The minor version of the Decision Service. This field is optional

### Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

- `application/json`

### Responses

#### 200

OK. Get the properties for the Decision Service.

#### 400

Bad Request

#### 404

Not found

#### 500

Internal Server Error

Up

    get /decisionService/getVocabularyMetadata

Get Decision Service vocabulary metadata (getDecisionServiceVocabularyMetadata)
Gets the vocabulary metadata for the Decision Service.

### Query parameters

name (required)
Query Parameter — The name of the Decision Service
majorVersion (optional)
Query Parameter — The major version of the Decision Service. This field is optional but required if minorVersion is execute.
minorVersion (optional)
Query Parameter — The minor version of the Decision Service. This field is optional

### Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

- `application/json`

### Responses

#### 200

OK. Get the vocabulary metadata for the Decision Service.

#### 400

Bad Request

#### 404

Not found

#### 500

Internal Server Error

Up

    get /decisionService/list

Gets a list of all the Decision Services (getJsonDecisionServicesList)
Fetch list of all the decision Services.

### Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

- `application/json`

### Responses

#### 200

OK. Returns the list of decision services

#### 204

No Content (the list is empty, the payload returns an empty JSON array)

#### 404

Not found

#### 500

Internal Server Error

Up

    post /decisionService/deploy

Deploys a Decision Service. (postCorticonDeployDecisionService)
Attempts to add a Decision Service to the server. Request objects are sent as the JSON Object. The edsFile attribute sent as part of the JSON Object should be base64 encoded binary contents of the eds.

### Consumes

This API call consumes the following media types via the Content-Type request header:

- `application/json`

### Request body

body JsonObject - DeployDecisionService (required)
Body Parameter — JSON required to deploy a Decision Service

### Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

- `application/json`

### Responses

#### 200

OK. Deploys the Decision Service to the server.

#### 400

Bad Request

#### 404

Not found

#### 500

Internal Server Error

Up

    post /decisionService/registerMonitoredAttributes

Registers a Decision Service attribute for monitoring (postCorticonRegisterMonitoredAttributes)
Registers a Decision Service attribute for monitoring

### Consumes

This API call consumes the following media types via the Content-Type request header:

- `application/json`

### Request body

body JsonObject - MonitoredAttributes (required)
Body Parameter — JSON required to register monitored attributes

### Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

- `application/json`

### Responses

#### 200

OK. Registers a Decision Service attribute for monitoring

#### 400

Bad Request

#### 404

Not found

#### 500

Internal Server Error

Up

    post /decisionService/reloadQueryService

Reloads the Query Service for a desired Decision Service (postCorticonReloadDecisionServiceQueryService)
Reloads the Query Service for a desired Decision Service

### Query parameters

name (required)
Query Parameter — The name of the Decision Service
majorVersion (optional)
Query Parameter — The major version of the Decision Service. This field is optional but required if minorVersion is execute.
minorVersion (optional)
Query Parameter — The minor version of the Decision Service. This field is optional

### Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

- `application/json`

### Responses

#### 200

OK. Reloaded Decision Service Query Service.

#### 400

Bad Request

#### 404

Not found

#### 500

Internal Server Error

Up

    post /decisionService/setProperties

Sets Decision Service properties (postCorticonSetDecisionServiceProperties)
Attempts to modify the properties of a specified Decision Service. The information about the Decision Service must either be passed as part of the JSON payload or specified in the header. The properties to be set must contain a key/value format. The properties which can be set can be viewed using the GET Decision Service Properties API.The returned object is a list of key/value pairs representing the properties that were attemped to set.

### Consumes

This API call consumes the following media types via the Content-Type request header:

- `application/json`

### Request body

body JsonObject - Properties (required)
Body Parameter — JSON required containing key/value format

### Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

- `application/json`

### Responses

#### 200

OK. Set the properties for the Decision Service.

#### 400

Bad Request

#### 404

Not found

#### 500

Internal Server Error

Up

    post /decisionService/unRegisterMonitoredAttributes

Unregisters a Decision Service monitored attribute (postCorticonUnRegisterMonitoredAttributes)
Unregisters a Decision Service monitored attribute

### Consumes

This API call consumes the following media types via the Content-Type request header:

- `application/json`

### Request body

body JsonObject - MonitoredAttributes (required)
Body Parameter — Json required to unregister monitored attributes

### Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

- `application/json`

### Responses

#### 200

OK. Unregisters a Decision Service monitored attribute

#### 400

Bad Request

#### 404

Not found

#### 500

Internal Server Error

Up

    post /decisionService/undeploy

Undeploys Decision Service (postCorticonUndeployDecisionService)
Attempts to remove the specified Decision Service from the server, and deletes the EDS file associated with it.

### Consumes

This API call consumes the following media types via the Content-Type request header:

- `application/json`

### Request body

body JsonObject - DecisionService (required)
Body Parameter — JSON payload for Decision Service we are trying to remove

### Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

- `application/json`

### Responses

#### 200

OK. Undeploys the Decision Service from the server.

#### 400

Bad Request

#### 404

Not found

#### 500

Internal Server Error

Up

    post /decisionService/update

Updates a Decision Service (postCorticonUpdateDecisionService)
Updates a Decision Service

### Consumes

This API call consumes the following media types via the Content-Type request header:

- `application/json`

### Request body

body JsonObject - UpdateDecisionService (required)
Body Parameter — JSON required to deploy a Decision Service

### Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

- `application/json`

### Responses

#### 200

OK. Updates a Decision Service

#### 400

Bad Request

#### 404

Not found

#### 500

Internal Server Error

# ServerOperationsOnTheServer

Up

    get /server/getProperties

Gets Server properties. (getCorticonGetServerProperties)
Returns the properties that pertain to the server. The returned object is a list of key/value pairs consisting of: "PropertyName":"PropertyValue" where value is the current value of the property.

### Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

- `application/json`

### Responses

#### 200

OK. Returns the properties for the Server

#### 404

Not found

#### 500

Internal Server Error

Up

    get /server/ping

Ping the server to get how long it has been up and running. (getPingServer)
Get server uptime in miliseconds.

### Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

- `application/json`

### Responses

#### 200

OK. Returns the number of miliseconds the sever has been up and running

#### 204

No Content (the list is empty, the payload returns an empty JSON array)

#### 404

Not found

#### 500

Internal Server Error

Up

    post /server/setLicense

Sets Server license (postCorticonSetServerLicense)
Sets the license file for the server. This can be used to add a license in the event the current one is not usable.

### Consumes

This API call consumes the following media types via the Content-Type request header:

- `application/json`

### Request body

body JsonObject - ServerLicense (required)
Body Parameter — JSON required to set server license

### Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

- `application/json`

### Responses

#### 200

OK. An empty object is returned.

#### 400

Bad Request

#### 404

Not found

#### 500

Internal Server Error

Up

    post /server/setProperties

Sets Server properties (postCorticonSetServerProperties)
Sets properties on the server using a JSON object. The object contains a key/value format system of the form name : value intended to be set for this property. The response contains a JSON object similar to what returns in getProperties. There is a list of key/value pairs representing the properties that were attempted to be set. The pairs name:value object representing success/failure of setting the property value.

### Consumes

This API call consumes the following media types via the Content-Type request header:

- `application/json`

### Request body

body JSONObject (optional)
Body Parameter — JSON required to set the server properties

### Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

- `application/json`

### Responses

#### 200

OK. Set the properties for the Server.

#### 400

Bad Request

#### 404

Not found

#### 500

Internal Server Error

## Models

[ Jump to Methods ]

### Table of Contents

1. `JSONArray` -
2. `JSONObject` -
3. `JSONObject - Start Batch Execution` -
4. `JsonObject - DecisionService` -
5. `JsonObject - DeployDecisionService` -
6. `JsonObject - Execute Decision Service` -
7. `JsonObject - MonitoredAttributes` -
8. `JsonObject - Objects` -
9. `JsonObject - Properties` -
10. `JsonObject - ServerLicense` -
11. `JsonObject - UpdateDecisionService` -
12. `MonitoredAttributes` -

### `JSONArray` - Up

### `JSONObject` - Up

### `JSONObject - Start Batch Execution` - Up

majorVersion (optional)
Integer format: int32
minorVersion (optional)
Integer format: int32
datasourceName
String The name of the Datasource
variables (optional)
JSONObject
idsPerFetch (optional)
Integer format: int32
entitiesPerPayload (optional)
Integer format: int32
processingThreadCount (optional)
Integer format: int32
enableLogging (optional)
String
logPath (optional)
String
decisionServiceName
String The name of the Decision Service
batchReadName
String The name of the Batch Read
cachedEntities (optional)
JSONArray Array of cachedEntities defined in the Vocabulary

### `JsonObject - DecisionService` - Up

name
String The name of the Decision Service
majorVersion (optional)
String The major version of the Decision Service
minorVersion (optional)
String The minor version of the Decision Service

### `JsonObject - DeployDecisionService` - Up

edsFile
String Base64 Encoded binary of the eds file contents
edsFileName (optional)
String The name of the eds file that is being uploaded
name
String The name of the Decision Service that is being sent to the server
minPoolSize (optional)
String The minimum server pool size DEPRECATED
maxPoolSize (optional)
String The maximum server pool size
msgStyle (optional)
String The XML message style to be used for this Decision Service
Enum:
HIER
FLAT
dbAccessMode (optional)
String The database access mode
dbReturnMode (optional)
String The database access Entities Return mode
dbPropFile (optional)
String Base64 Encoded binary of the database properties file
dbPropFileName (optional)
String The name of the eds properties file

### `JsonObject - Execute Decision Service` - Up

name
String The name of the Decision Service
majorVersion (optional)
String The major version of the Decision Service
minorVersion (optional)
String The minor version of the Decision Service
effectiveTimestamp
String The effectiveTimestamp of the Decision Service
Objects (optional)
array[JsonObject - Objects]

### `JsonObject - MonitoredAttributes` - Up

name
String The name of the Decision Service
majorVersion (optional)
String The major version
minorVersion (optional)
String The minor version
monitoredAttributes
array[MonitoredAttributes] Array of monitored attributes

### `JsonObject - Objects` - Up

### `JsonObject - Properties` - Up

name
String The name of the Decision Service
majorVersion (optional)
String The major version of the Decision Service
minorVersion (optional)
String The minor version of the Decision Service
propertyName
String name/value pair for the property to be set
example: value

### `JsonObject - ServerLicense` - Up

licenseFile
String The license file encoded into a base64 string
licenseFileName (optional)
String The name of the license file

### `JsonObject - UpdateDecisionService` - Up

edsFile
String Base64 Encoded binary of the eds file contents
edsFileName (optional)
String The name of the eds file that is being uploaded
name
String The name of the Decision Service
minPoolSize (optional)
String The minimum server pool size DEPRECATED
maxPoolSize (optional)
String The maximum server pool size
msgStyle (optional)
String The XML message style to be used for this Decision Service
Enum:
HIER
FLAT
dbAccessMode (optional)
String The database access mode
dbReturnMode (optional)
String The database access Entities Return mode
dbPropFile (optional)
String Base64 Encoded binary of the database properties file
dbPropFileName (optional)
String The name of the eds properties file
majorVersion (optional)
String The major version of the Decision Service
minorVersion (optional)
String The minor version of the Decision Service
autoReload
String Set true to autoReload the Decision Service

### `MonitoredAttributes` - Up

attribute
String The name of the attribute that needs to be monitored
example: Order.total
analysisBucket (optional)
String The analysis bucket for the attribute
example: <10, 10,>10