LogoLogo
API Documentation
Version 1.19.5 and Older
Version 1.19.5 and Older
  • DecisionRules Documentation
  • API
    • API Introduction
    • API Keys
      • Solver API Keys
      • Management API keys
      • BI API keys
    • Rule Solver API
    • Management API
      • Deprecated Endpoints
    • Console Logs API
    • Business Intelligence API
      • Deprecated Endpoints
    • Datacenters & Locations
      • Global Cloud
      • Regional Cloud
    • Apache Kafka Solver API
    • Endpoint Settings
    • Archive
      • Rule Flow Solver API (DEPRECATED)
  • Decision tables
    • Decision Tables Introduction
    • Table Designer
    • Input & Output JSON Model
      • Simple Editor
      • JSON Editor
      • Binding to Model
    • Supported Data Types
    • Operators and Functions
      • Basic operators
      • Date operators
      • Functions
        • Logical Functions
        • Math Functions
        • Date and Time Functions
        • Text Functions
        • Data Functions
        • Array Functions
        • Integration functions
        • Functions and JSON
    • Export & Import of Decision Tables
      • Export Decision Table
      • Import Decision Table
      • File Structure of JSON Format
      • Managing Decision Table in Excel/Google Sheets
      • Deprecated Formats: XLSX v.1 and CSV
    • Table Operations
      • Filter Values
      • Valid Values
      • Sorting
  • Decision Trees
    • Decision Trees Introduction
    • Decision Tree Designer
    • Export & Import Decision Trees
      • Export Decision Tree
      • Import Decision Tree
  • Scripting Rules
    • Scripting Rule Introduction
    • Custom functions in Scripting Rules
    • Calling external API within ScriptingRules
    • Use Rule Variables in Scripting Rules
    • Call Embedded Rules in Scripting Rules
    • Export & Import Scripting Rules
      • Export Scripting Rule
      • Import Scripting Rule
    • Tips
  • Rule Flow
    • Rule Flow Designer
    • Rule Flow Mapping
    • Rule States in Rule Flow
    • Warnings & Errors
    • Rule Flow Limits
    • Export & Import Rule Flows
      • Export Rule Flow
      • Import Rule Flow
  • Workflow
    • Workflow Introduction
    • Workflow Designer
    • Workflow Nodes Overview
    • Workflow Limits
  • Other
    • Rule Alias
    • Execution Strategy
    • Rule State
    • Rule Versioning
    • Favorite Rules
    • Rule Variables
    • Rule Comparison
      • Decision Table Comparison
      • Decision Tree Comparison
      • Scripting Rule Comparison
    • Rule Tags
    • Rule Dependencies
    • Test Bench
    • Single Sign-On (SSO)
    • Event timeline
    • Rule Lock
    • Rule Migration Strategies
    • Changes in Version 1.19.0 (10/2024)
  • Organizations
    • Introduction
      • Access to Organization
    • Structure
      • Organization Roles
      • Members
      • Teams
      • Spaces
      • Space Roles
      • Policies
      • Settings
  • Teamwork
    • Dashboard
    • Folders
    • Spaces
    • Manage Spaces
    • Share Rules Between Spaces
    • Users & Roles
    • Teamwork Indicator
  • SDK and Integrations
    • Languages / Frameworks
      • SQL Server
      • Oracle PL/SQL
      • PostgreSQL
      • JavaScript
      • Java Spring Example
      • PHP Library
      • Python Library
      • .NET Library
      • Google Tag Manager
    • Excel Add-in
  • Business Intelligence
    • Audit Logs
    • Create a Power BI Report
    • Connect Power BI to Business Intelligence API
    • Connecting from Power BI (deprecated)
    • Connect DecisionRules to Power BI Using Our Custom Connector
  • Billing
    • Invoices & Billing
    • Change Product Plan
    • Billing Information
    • Plan Limits Explained
  • Regional Cloud
    • Regional Cloud
    • Region Specific API URLs
  • On-Premise / Docker
    • Environment Variables
    • Redis Connection Modes
    • Setup Single Sign-On (SSO)
      • Set up Microsoft Entra ID SSO
      • Set up Google SSO
    • DecisionRules Application
      • Minimal Requirements
      • DecisionRules Server
      • DecisionRules Client
      • DecisionRules Business Intelligence
      • Networking Between Docker Containers
    • Docker Showcase App
      • Showcase
      • Showcase + Business Intelligence
    • AWS Setup
      • AWS ECS/Fargate
      • Cache - Amazon ElastiCache
    • Microsoft Azure Setup
      • Database - Azure CosmosDB
      • Cache - Azure Cache for Redis
      • Azure Container Apps
    • Azure Red Hat OpenShift
    • Google Kubernetes Engine (GKE)
    • Kubernetes Setup
      • Kubernetes Setup with Business Intelligence
    • Logging options
    • CD/CI Pipelines
      • Azure DevOps CICD Pipelines
      • Using Migration script (old way)
    • Offline License
  • Terms & Conditions
    • Terms and Conditions
    • Privacy Policy
    • Service Level Agreement
      • Community Support
      • Standard Cloud (SaaS)
      • Silver SLA
      • Gold SLA
      • Custom SLA
    • Sub-Processor List
  • Roadmap 🚲 🗺️
  • Release Notes
    • Public Cloud
    • On-Premise / Private Cloud
Powered by GitBook
On this page
  • Making API calls on Region Cloud accounts
  • A few examples
  • Solve Rule
  • Updating a rule through the Managment API
  • Update rule
  • Getting Console Logs for a rule solve through the Console Logs API
  • Get Console Logs for a solve

Was this helpful?

  1. Regional Cloud

Region Specific API URLs

Was this helpful?

Making API calls on Region Cloud accounts

The process of calling the Rule Solver, Managment API or BI API is the same for region-locked accounts and Global Cloud accounts. The only difference is the endpoint URL.

With the Regional Cloud accounts having to prepend the URL with their respective regional shortcut.

Location
Shortcut
API call URL example

us

https://us.api.decisionrules.io/:PATH

eu

https://eu.api.decisionrules.io/:PATH

au

https://au.api.decisionrules.io/:PATH

A few examples

Solving a rule through the Solver API

Let's say you want to solve a rule on an account registered in the United States. We would follow the instructions in the and simply prepend the usual URL with our region's shortcut. In this case 'us', forming the following request:

Solve Rule

POST https://us.api.decisionrules.io/rule/solve/:ruleId/:version

Path Parameters

Name
Type
Description

ruleId*

string

Unique identifier rule that is common to all rule versions. Instead of rule ID, it is possible to use rule alias.

version

integer

Business rule version. If the parameter is not filled in, the last published version will be used automatically. See more on versioning.

Headers

Name
Type
Description

Authorization*

string

Bearer <Solver API Key>

Content-Type

string

application/json

X-Strategy

string

STANDARD or ARRAY or FIRST_MATCH.

X-Correlation-Id

string

Correlation ID, in case you would like to set it manually. If not present, correlation ID will be generated automatically. In any case, the correlation ID is returned in the same header of the response.

X-Audit

string

Decides whether an audit of the solve should be created and saved. In case you want the audit to be created and saved, input "true".

X-Audit-Ttl

string

A number that dictates after how many days the audit will be deleted. Set to 14 days by default.

X-Debug

string

Allows to switch on the debug mode, which is by default off. Set this header to "true" if you want to activate it.

Request Body

Name
Type
Description

data

object

JSON object that describes the input json data.

options

object

Object specifying solver options.

[
    {
        "car": {
            "price": "666666",
            "seats": {},
            "discount": {
                "low": "2",
                "high": "33"
            }
        }
    },
    {
        "car": {
            "price": "8888888",
            "seats": {},
            "discount": {
                "low": "8",
                "high": "33"
            }
        }
    }
]
{
    "error": {
        "message": "Unknown rule or rule version"
    }
}
{
    "error": {
        "message": "Authentication token missing"
    }
}

Updating a rule through the Managment API

Update rule

PUT https://eu.api.decisionrules.io/api/rule/:ruleId/:version

Path Parameters

Name
Type
Description

rule Id

string

Unique rule ID which is common to all rule versions. You can also use rule alias.

version

integer

Version of Rule

Headers

Name
Type
Description

Authorization

string

Bearer

Request Body

Name
Type
Description

body

object

JSON format of a rule

TypeError: rule.decisionTable.rows is not iterable
{
    "error": {
        "message": "Authentication token missing"
    }
}

Getting Console Logs for a rule solve through the Console Logs API

Get Console Logs for a solve

GET https://au.api.decisionrules.io/consoleLogs/:correlationId

Query Parameters

Name
Type
Description

correlationId*

String

CorrelationId of specific solve

Headers

Name
Type
Description

Authorization*

String

Bearer <Solver API Key>

USA

European Union

Australia

Let's say you want to update a rule on an account registered in the EU. We would follow the instructions in the and simply prepend the usual URL with our region's shortcut. In this case 'eu', forming the following request:

Let's say you want to get console logs for a rule solve on an account registered in Australia. We would follow the instructions in the and simply prepend the usual URL with our region's shortcut. In this case 'au', forming the following request:

More in execution strategies
Rule Solver API article
Console Logs API article
Management API article