Integration API

The token obtained from the Authorization service must be included in the Authorization request header when calling all integration services.

Rule Execution APIs

• These APIs are used by applications to execute rules.

• They enable invoking rules, sending parameters, and receiving results.

Executes all rules belonging to a category.

executeWithCategory

post

Query parameters

baseDatestring · dateRequired

baseDate

categoryCodestringRequired

categoryCode

includeSubCategoriesbooleanOptional

includeSubCategories

Body

application/json

Responses

200

OK

*/*

localProcessCodestringOptional

201

Created

401

Unauthorized

403

Forbidden

404

Not Found

post

/public/ruleExecuterApi/executeWithCategory

HTTPcURLJavaScriptPython

POST /public/ruleExecuterApi/executeWithCategory?baseDate=2026-03-31&categoryCode=text HTTP/1.1
Host: 127.0.0.1/
Content-Type: application/json
Accept: */*
Content-Length: 105

{
  "context": [
    {
      "code": "text",
      "value": "text",
      "values": [
        "text"
      ]
    }
  ],
  "halter": [
    {
      "code": "text",
      "result": "text"
    }
  ]
}

{
  "localProcessCode": "text",
  "results": {
    "ANY_ADDITIONAL_PROPERTY": [
      {
        "code": "text",
        "multiple": true,
        "name": "text",
        "value": "text",
        "values": [
          "text"
        ]
      }
    ]
  }
}

Executes a single rule

execute

post

Query parameters

baseDatestring · dateRequired

baseDate

pathstringRequired

path

Body

application/json

Responses

200

OK

*/*

localProcessCodestringOptional

201

Created

401

Unauthorized

403

Forbidden

404

Not Found

post

/public/ruleExecuterApi/executeWithPath

HTTPcURLJavaScriptPython

POST /public/ruleExecuterApi/executeWithPath?baseDate=2026-03-31&path=text HTTP/1.1
Host: 127.0.0.1/
Content-Type: application/json
Accept: */*
Content-Length: 62

{
  "context": [
    {
      "code": "text",
      "value": "text",
      "values": [
        "text"
      ]
    }
  ]
}

{
  "localProcessCode": "text",
  "results": [
    {
      "code": "text",
      "multiple": true,
      "name": "text",
      "value": "text",
      "values": [
        "text"
      ]
    }
  ]
}

Executes multiple rules

executeWithPaths

post

Query parameters

baseDatestring · dateRequired

baseDate

pathsstring[]Required

paths

Body

application/json

Responses

200

OK

*/*

localProcessCodestringOptional

201

Created

401

Unauthorized

403

Forbidden

404

Not Found

post

/public/ruleExecuterApi/executeWithPaths

HTTPcURLJavaScriptPython

POST /public/ruleExecuterApi/executeWithPaths?baseDate=2026-03-31&paths=text HTTP/1.1
Host: 127.0.0.1/
Content-Type: application/json
Accept: */*
Content-Length: 105

{
  "context": [
    {
      "code": "text",
      "value": "text",
      "values": [
        "text"
      ]
    }
  ],
  "halter": [
    {
      "code": "text",
      "result": "text"
    }
  ]
}

{
  "localProcessCode": "text",
  "results": {
    "ANY_ADDITIONAL_PROPERTY": [
      {
        "code": "text",
        "multiple": true,
        "name": "text",
        "value": "text",
        "values": [
          "text"
        ]
      }
    ]
  }
}

The Options services provide the list of parameters used in the rule.

Returns the parameters of the rules under the category

optionsPathExpression

get

Query parameters

baseDatestring · dateRequired

baseDate

categoryCodestringRequired

categoryCode

includeSubCategoriesbooleanOptional

includeSubCategories

Responses

200

OK

*/*

401

Unauthorized

403

Forbidden

404

Not Found

get

/public/ruleExecuterApi/optionsForCategory

HTTPcURLJavaScriptPython

GET /public/ruleExecuterApi/optionsForCategory?baseDate=2026-03-31&categoryCode=text HTTP/1.1
Host: 127.0.0.1/
Accept: */*

{
  "ANY_ADDITIONAL_PROPERTY": {
    "description": "text",
    "in": [
      {
        "code": "text",
        "dataType": "text",
        "multiple": true,
        "name": "text"
      }
    ],
    "name": "text",
    "out": [
      {
        "code": "text",
        "dataType": "text",
        "multiple": true,
        "name": "text"
      }
    ]
  }
}

Returns the parameters of a single rule

options

get

Query parameters

baseDatestring · dateRequired

baseDate

pathstringRequired

path

Responses

200

OK

*/*

descriptionstringOptional

namestringOptional

401

Unauthorized

403

Forbidden

404

Not Found

get

/public/ruleExecuterApi/optionsForPath

HTTPcURLJavaScriptPython

GET /public/ruleExecuterApi/optionsForPath?baseDate=2026-03-31&path=text HTTP/1.1
Host: 127.0.0.1/
Accept: */*

{
  "description": "text",
  "in": [
    {
      "code": "text",
      "dataType": "text",
      "multiple": true,
      "name": "text"
    }
  ],
  "name": "text",
  "out": [
    {
      "code": "text",
      "dataType": "text",
      "multiple": true,
      "name": "text"
    }
  ]
}

Returns the parameters of multiple rules

optionsForPaths

get

Query parameters

baseDatestring · dateRequired

baseDate

pathsstring[]Required

paths

Responses

200

OK

*/*

401

Unauthorized

403

Forbidden

404

Not Found

get

/public/ruleExecuterApi/optionsForPaths

HTTPcURLJavaScriptPython

GET /public/ruleExecuterApi/optionsForPaths?baseDate=2026-03-31&paths=text HTTP/1.1
Host: 127.0.0.1/
Accept: */*

{
  "ANY_ADDITIONAL_PROPERTY": {
    "description": "text",
    "in": [
      {
        "code": "text",
        "dataType": "text",
        "multiple": true,
        "name": "text"
      }
    ],
    "name": "text",
    "out": [
      {
        "code": "text",
        "dataType": "text",
        "multiple": true,
        "name": "text"
      }
    ]
  }
}