☰
Navigation :

API Reference

This is the formal definition of the Avola Execution-API.

When calling the API from an external application you can request to use a specific version of a REST endpoint for execution.

Either send a Custom Header along the request: Key=api-version Value={Version}. Or request it in the Accept-Header: Key=Accept Value=application/json;api-version={Version}

V2 changes

Version 2 introduces a new property ‘ExecutionKey’ in the result when executing.

V3 changes (Default starting v2.1.10)

Version 3 introduces a new property ‘RowAnnotations’ in the result when executing.

Avola API Definition

/api/ApiExecution/execute

POST

Summary: V2: Execute a descision service version, this returns all conclusions, from all decisions in the decision service

Parameters

Name Located in Description Required Schema
executionrequest body Yes ApiExecutionRequest

Responses

Code Description Schema API Version
200 OK ExecutionResult v1
200 OK ExecutionResultV2 v2
200 OK ExecutionResultV3 v3 (Default)

/api/ApiExecution/execute/notrace

POST

Summary: Execute a decision service version, but returns only the final conclusion

Parameters

Name Located in Description Required Schema
executionRequest body Yes ApiExecutionRequest

Responses

Code Description Schema API Version
200 OK ExecutionResult v1
200 OK ExecutionResultV2 v2
200 OK ExecutionResultV3 v3 (Default)

/api/ApiExecution/execute/batch

POST

Summary: Like Execute, but expects an array of requests. Use the reference field to map the results on the requests

Parameters

Name Located in Description Required Schema
executionrequests body Yes [ ApiExecutionRequest ]

Responses

Code Description Schema API Version
200 OK ExecutionResult v1
200 OK ExecutionResultV2 v2
200 OK ExecutionResultV3 v3 (Default)

/api/ApiExecution/execute/batch/notrace

POST

Summary: Like Execute/notrace, but expects an array of requests. Use the reference field to map the results on the requests

Parameters

Name Located in Description Required Schema
executionrequests body Yes [ ApiExecutionRequest ]

Responses

Code Description Schema API Version
200 OK ExecutionResult v1
200 OK ExecutionResultV2 v2
200 OK ExecutionResultV3 v3 (Default)

/api/ApiExecution/decisions/list

GET

Summary: Will return you the list and details of all decision services and their versions, that the logged in account has access to.

Responses

Code Description Schema
200 OK [ DecisionServiceDescription ]

/api/ApiExecution/decisions/{decisionServiceId}

GET

Summary: Will return you the versions and details of a specific decision service.

Parameters

Name Located in Description Required Schema
decisionServiceId path Yes integer

Responses

Code Description Schema
200 OK [ DecisionServiceDescription ]

/api/ApiExecution/decisions/{decisionServiceId}/{version}

GET

Summary: Will return you the details of a specific decision service version.

Parameters

Name Located in Description Required Schema
decisionServiceId path Yes integer
version path Yes integer

Responses

Code Description Schema
200 OK DecisionServiceVersionDescription

/api/ApiExecution/executions/ref/{reference}

GET

Summary: Will return the top 20 of executions that were executed with the given reference.

Parameters

Name Located in Description Required Schema
reference path Yes string

Responses

Code Description Schema
200 OK [ DecisionExecutionMessage ]

/api/ApiExecution/executions/key/{executionkey}

GET

Summary: Will return the execution with the given executionkey

Parameters

Name Located in Description Required Schema
executionkey path Yes string

Responses

Code Description Schema
200 OK DecisionExecutionMessage

/api/Settings

GET

Responses

Code Description Schema
200 OK ApiDescription

Models

ApiExecutionRequest

Name Type Description Required
DecisionServiceId integer No
VersionNumber integer No
Reference string No
ExecutionRequestData [ ExecutionRequestData ] No
ExecutionRequestMetaData [ ExecutionRequestData ] No
FilterResult FilterResult No

ExecutionRequestData

Name Type Description Required
Key integer No
Value string No

FilterResult

Name Type Description Required
HitConclusionBusinessDataIds [ string ] No

ExecutionResult

Name Type Description Required
DecisionServiceId integer No
Reference string No
FinalConclusionBusinessDataIds [ integer ] No
ConclusionValueType string No
HitConclusions [ HitConclusion ] No
Errors [ ErrorMessage ] No

ExecutionResultV2

Name Type Description Required
DecisionServiceId integer No
Reference string No
ExecutionKey string No
FinalConclusionBusinessDataIds [ integer ] No
ConclusionValueType string No
HitConclusions [ HitConclusion ] No
Errors [ ErrorMessage ] No

ExecutionResultV3

Name Type Description Required
DecisionServiceId integer No
Reference string No
ExecutionKey string No
FinalConclusionBusinessDataIds [ integer ] No
ConclusionValueType string No
HitConclusionsV3 [ HitConclusion ] No
Errors [ ErrorMessage ] No

HitConclusion

Name Type Description Required
ConclusionName string No
ConclusionId integer No
DecisionTableName string No
DecisionTableId integer No
BusinessDataId integer No
RowId integer No
RowExpression string No
Value string No
RowOrder integer No

HitConclusionV3

Name Type Description Required
ConclusionName string No
ConclusionId integer No
DecisionTableName string No
DecisionTableId integer No
BusinessDataId integer No
RowId integer No
RowExpression string No
Value string No
RowOrder integer No
RowAnnotations [ RowAnnotations ] No

RowAnnotations

Name Type Description Required
RowAnnotationName string Name of the annotation column No
RowAnnotationId integer Unique Id of the annotation column No
Value string Value as defined on the hit row(s) under the annotation column No

ErrorMessage

Name Type Description Required
Message string No
Code string No
Values [ string ] No

DecisionServiceDescription

Name Type Description Required
DecisionServiceId integer No
Name string No
Versions [ DecisionServiceVersionDescription ] No

DecisionServiceVersionDescription

Name Type Description Required
DecisionServiceId integer No
Name string No
DecisionName string No
DecisionServiceVersionId integer No
VersionNumber integer No
InputData [ DecisionServiceVersionBusinessData ] No
OutputData [ DecisionServiceVersionBusinessData ] No
TraceData [ DecisionServiceVersionBusinessData ] No
MetaData [ DecisionServiceVersionBusinessData ] No
PairData [ DecisionServiceVersionPairData ] No
ListData [ DecisionServiceVersionListData ] No

DecisionServiceVersionBusinessData

Name Type Description Required
BusinessDataId integer No
Version integer No
Name string No
Type string No
Question string No
Properties [ BusinessDataProperty ] No

DecisionServiceVersionPairData

Name Type Description Required
PairId integer No
ValueForTrue string No
ValueForFalse string No

DecisionServiceVersionListData

Name Type Description Required
ListId integer No
Items [ DecisionServiceVersionListDataItem ] No

BusinessDataProperty

Name Type Description Required
Name string No
Value string No

DecisionServiceVersionListDataItem

Name Type Description Required
Id integer No
Order integer No
Value string No
Name string No

DecisionExecutionMessage

Name Type Description Required
Id string No
ExecutionRequest ApiExecutionRequest No
ExecutionResult ExecutionResultV3 No
ExecutionTime dateTime No
ExecutionDurationInMs integer No
ExecutionUser string No
EnvironmentLabel string No
Organisation string No

ApiDescription

Name Type Description Required
Organisation string No
Environment string No
ApiType string No
Authority string No
TokenEndpoint string No