Corticon REST API
Copyright © 2005-2024 Progress Software Corporation and/or one of its subsidiaries or affiliates. All rights reserved.
BasePath: /axis
[ Jump to Models ]
Table of Contents
Up
get /corticon/batchexecution/getIds
Get current list of Batch Execution Ids on the CcServer. (getBatchExecutionIds)
Fetch list of all Batch Execution Ids.
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 /corticon/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
Responses
200
OK. Get the details of the Batch Execution.
400
Bad Request
404
Not found
500
Internal Server Error
Up
post /corticon/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 request header:
Request body
Body Parameter — JSONObject containing parameters related to the Batch Execution.
Responses
200
OK. Batch Execution has started.
400
Bad Request
404
Not found
500
Internal Server Error
Up
post /corticon/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
Responses
200
OK. Batch Execution has started to stop all further executions.
400
Bad Request
404
Not found
500
Internal Server Error
Up
post /corticon/execute/nativejson
Executes a Decision Service (postJsonNativeJSONExecutionJSONObject)
Executes a Decision Service. The Decision Service payload is enclosed in the message body as a JSON string. This endpoint accepts a native JSON payload (JSONObject or JSONArray).
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — JSON payload to execute.
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 used.
minorVersion (optional)
Query Parameter — The minor version of the Decision Service. This field is optional
#enableRuleTrace (optional)
Query Parameter — Runtime property to return RuleTrace data in response. This field is optional
#restrictInfoRuleMessages (optional)
Query Parameter — Runtime property to restrict Info RuleMessages in the response. This field is optional
#restrictWarningRuleMessages (optional)
Query Parameter — Runtime property to restrict Warning RuleMessages in the response. This field is optional
#restrictViolationRuleMessages (optional)
Query Parameter — Runtime property to restrict Violation RuleMessages in the response. This field is optional
#restrictResponseToRuleMessagesOnly (optional)
Query Parameter — Runtime property to only return RuleMessages in the response. This field is optional
#locale (optional)
Query Parameter — Runtime property so set locale for this execution. This field is optional
#timezoneId (optional)
Query Parameter — Runtime property so set timezone id for this execution. This field is optional
Responses
200
OK. Executes the Decision Service.
400
Bad Request
404
Not found
500
Internal Server Error
Up
post /corticon/execute
Executes a Decision Service (postXmlExcution)
Executes a Decision Service. The Decision Service payload is enclosed in the message body as a string.
Consumes
This API call consumes the following media types via the request header:
application/jsonapplication/xml
Request body
Body Parameter — Payload to execute.
Responses
200
OK. Executes the Decision Service.
400
Bad Request
404
Not found
500
Internal Server Error
Up
get /corticon/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 used.
minorVersion (optional)
Query Parameter — The minor version of the Decision Service. This field is optional
Responses
200
OK. Get the properties for the Decision Service.
400
Bad Request
404
Not found
500
Internal Server Error
Up
get /corticon/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 used.
minorVersion (optional)
Query Parameter — The minor version of the Decision Service. This field is optional
Responses
200
OK. Get the vocabulary metadata for the Decision Service.
400
Bad Request
404
Not found
500
Internal Server Error
Up
get /corticon/decisionService/list
Gets a list of all the Decision Services (getJsonDecisionServicesList)
Fetch list of all the decision Services.
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 /corticon/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 request header:
Request body
Responses
200
OK. Deploys the Decision Service to the server.
400
Bad Request
404
Not found
500
Internal Server Error
Up
post /corticon/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
Responses
200
OK. Reloaded Decision Service Query Service.
400
Bad Request
404
Not found
500
Internal Server Error
Up
post /corticon/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 request header:
Request body
Responses
200
OK. Set the properties for the Decision Service.
400
Bad Request
404
Not found
500
Internal Server Error
Up
post /corticon/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 request header:
Request body
Responses
200
OK. Undeploys the Decision Service from the server.
400
Bad Request
404
Not found
500
Internal Server Error
Up
post /corticon/decisionService/update
Updates a Decision Service (postCorticonUpdateDecisionService)
Updates a Decision Service
Consumes
This API call consumes the following media types via the request header:
Request body
Responses
200
OK. Updates a Decision Service
400
Bad Request
404
Not found
500
Internal Server Error
Up
get /corticon/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.
Responses
200
OK. Returns the properties for the Server
404
Not found
500
Internal Server Error
Up
get /corticon/server/ping
Get server uptime in miliseconds. (getPingServer)
Ping the server to get how long it has been up and running.
Responses
200
OK. Returns the number of miliseconds the sever has been up and running
400
Bad Request
404
Not found
500
Internal Server Error
Up
post /corticon/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 request header:
Request body
Body Parameter — JSON payload to execute.
Responses
200
OK. An empty object is returned.
400
Bad Request
404
Not found
500
Internal Server Error
Up
post /corticon/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 request header:
Request body
Body Parameter — JSON required to set the server properties
Responses
200
OK. Set the properties for the Server.
400
Bad Request
404
Not found
500
Internal Server Error
[ Jump to Methods ]
Table of Contents
DecisionServiceModelDeployDecisionServiceExecuteBatchModelExecuteDecisionServiceModelExecuteDecisionServiceNativeJSONModelJSONArrayJSONObjectObjectsRestSwaggerPropertiesModelServerSetLicenseUpdateDecisionService
JsonObject - DecisionService
name
String The name of the Decision Service
majorVersion
String The major version of the Decision Service
minorVersion
String The minor version of the Decision Service
JsonObject - DeployDecisionService
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
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 - Start Batch Execution
datasourceName
String The name of the Datasource
decisionServiceName
String The name of the Decision Service
batchReadName
String The name of the Batch Read
variables (optional)
cachedEntities (optional)
JsonObject - Execute Decision Service
effectiveTimestamp
String The effectiveTimestamp of the Decision Service
majorVersion (optional)
String The major version of the Decision Service
minorVersion (optional)
String The minor version of the Decision Service
Objects
array[Objects] The collection of input objects to be processed by the Decision Service
name
String The name of the Decision Service to execute against
JsonObject - Native JSON Execute Decision Service
Array of cachedEntities defined in the Vocabulary
The variables allows you to pass in name/value pairs that can be applied to the Batch Read's SQL Statement
JsonObject - Properties
name
String The name of the Decision Service
majorVersion
String The major version of the Decision Service
minorVersion
String The minor version of the Decision Service
propertyName
String name/value pair for the property to be set
example: value
JsonObject - ServerLicense
licenseFile
String The license file encoded into a base64 string
licenseFileName (optional)
String The name of the license file
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
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