DecisionRules

decisionRules

list DecisionRule (master: default)

get

Represents a rule, defining conditions and actions logic.

Authorizations

basicAuthapi_key

Query parameters

pageIndexnumber · int32Optional

Page number to return, starting with zero

pageSizenumber · int32Optional

Number of records per page (default 100)

orderByFieldstringOptional

Field name to order by (or comma separated names)

pageNoLimitstringOptional

If true don't limit page size (no pagination)

dependentLevelsnumber · int32Optional

Levels of dependent child records to include

ruleIdstringOptional

Unique identifier for the rule.

ruleGroupIdstringOptional

Unique identifier for the rule group.

ruleNamestringOptional

Name of the rule.

statusIdstringOptional

Status of the rule.

sequenceNumnumber · int64Optional

Sequence number for ordering.

createdDatestring · date-timeOptional

Date and time when the rule was created.

createdByUserstringOptional

User login ID of the creator.

lastUpdatedStampstring · date-timeOptional

Responses

200

Success

application/json

401

Authentication required

403

Access Forbidden (no authz)

404

Value Not Found

429

Too Many Requests (tarpit)

500

General Error

get

HTTPcURLJavaScriptPython

GET /rest/s1/available-to-promise/decisionRules HTTP/1.1
Host: dev-maarg.hotwax.io
Authorization: Basic username:password
Accept: */*

[
  {
    "_entity": "rule",
    "ruleId": "text",
    "ruleGroupId": "text",
    "ruleName": "text",
    "statusId": "text",
    "sequenceNum": 1,
    "createdDate": "2025-07-11T16:10:43.850Z",
    "createdByUser": "text",
    "lastUpdatedStamp": "2025-07-11T16:10:43.850Z",
    "ruleConditions": [
      {
        "_entity": "ruleCondition",
        "ruleId": "text",
        "conditionSeqId": "text",
        "conditionTypeEnumId": "text",
        "fieldName": "text",
        "operator": "text",
        "fieldValue": "text",
        "sequenceNum": 1,
        "createdDate": "2025-07-11T16:10:43.850Z",
        "lastUpdatedStamp": "2025-07-11T16:10:43.850Z",
        "ruleConditionType": {
          "_entity": "enums",
          "enumId": "text",
          "enumTypeId": "text",
          "parentEnumId": "text",
          "enumCode": "text",
          "sequenceNum": 1,
          "description": "text",
          "optionValue": "text",
          "optionIndicator": "text",
          "relatedEnumId": "text",
          "relatedEnumTypeId": "text",
          "statusFlowId": "text",
          "enumName": "text",
          "primaryEnumerationGroupId": "text",
          "lastUpdatedStamp": "2025-07-11T16:10:43.850Z"
        }
      }
    ],
    "ruleActions": [
      {
        "_entity": "ruleAction",
        "ruleId": "text",
        "actionSeqId": "text",
        "actionTypeEnumId": "text",
        "fieldName": "text",
        "fieldValue": "text",
        "sequenceNum": 1,
        "createdDate": "2025-07-11T16:10:43.850Z",
        "lastUpdatedStamp": "2025-07-11T16:10:43.850Z",
        "ruleActionType": {
          "_entity": "enums",
          "enumId": "text",
          "enumTypeId": "text",
          "parentEnumId": "text",
          "enumCode": "text",
          "sequenceNum": 1,
          "description": "text",
          "optionValue": "text",
          "optionIndicator": "text",
          "relatedEnumId": "text",
          "relatedEnumTypeId": "text",
          "statusFlowId": "text",
          "enumName": "text",
          "primaryEnumerationGroupId": "text",
          "lastUpdatedStamp": "2025-07-11T16:10:43.850Z"
        }
      }
    ]
  }
]

store DecisionRule

post

Represents a rule, defining conditions and actions logic.

Authorizations

basicAuthapi_key

Body

application/jsonmultipart/form-data

_entitystringOptionalDefault: rule

ruleIdstringOptional

ruleGroupIdstringOptional

ruleNamestringOptional

statusIdstringOptional

sequenceNumnumber · int64Optional

createdDatestring · date-timeOptional

createdByUserstringOptional

lastUpdatedStampstring · date-timeOptional

Responses

200

Success

application/json

401

Authentication required

403

Access Forbidden (no authz)

404

Value Not Found

429

Too Many Requests (tarpit)

500

General Error

post

HTTPcURLJavaScriptPython

POST /rest/s1/available-to-promise/decisionRules HTTP/1.1
Host: dev-maarg.hotwax.io
Authorization: Basic username:password
Content-Type: application/json
Accept: */*
Content-Length: 217

{
  "_entity": "rule",
  "ruleId": "text",
  "ruleGroupId": "text",
  "ruleName": "text",
  "statusId": "text",
  "sequenceNum": 1,
  "createdDate": "2025-07-11T16:10:43.850Z",
  "createdByUser": "text",
  "lastUpdatedStamp": "2025-07-11T16:10:43.850Z"
}

application/jsonmultipart/form-data

{
  "_entity": "rule.PK",
  "ruleId": "text"
}

one DecisionRule (master: default)

get

Represents a rule, defining conditions and actions logic.

Authorizations

basicAuthapi_key

Path parameters

ruleIdstringRequired

Unique identifier for the rule.

Responses

200

Success

application/json

401

Authentication required

403

Access Forbidden (no authz)

404

Value Not Found

429

Too Many Requests (tarpit)

500

General Error

get

HTTPcURLJavaScriptPython

GET /rest/s1/available-to-promise/decisionRules/{ruleId} HTTP/1.1
Host: dev-maarg.hotwax.io
Authorization: Basic username:password
Accept: */*

{
  "_entity": "rule",
  "ruleId": "text",
  "ruleGroupId": "text",
  "ruleName": "text",
  "statusId": "text",
  "sequenceNum": 1,
  "createdDate": "2025-07-11T16:10:43.850Z",
  "createdByUser": "text",
  "lastUpdatedStamp": "2025-07-11T16:10:43.850Z",
  "ruleConditions": [
    {
      "_entity": "ruleCondition",
      "ruleId": "text",
      "conditionSeqId": "text",
      "conditionTypeEnumId": "text",
      "fieldName": "text",
      "operator": "text",
      "fieldValue": "text",
      "sequenceNum": 1,
      "createdDate": "2025-07-11T16:10:43.850Z",
      "lastUpdatedStamp": "2025-07-11T16:10:43.850Z",
      "ruleConditionType": {
        "_entity": "enums",
        "enumId": "text",
        "enumTypeId": "text",
        "parentEnumId": "text",
        "enumCode": "text",
        "sequenceNum": 1,
        "description": "text",
        "optionValue": "text",
        "optionIndicator": "text",
        "relatedEnumId": "text",
        "relatedEnumTypeId": "text",
        "statusFlowId": "text",
        "enumName": "text",
        "primaryEnumerationGroupId": "text",
        "lastUpdatedStamp": "2025-07-11T16:10:43.850Z"
      }
    }
  ],
  "ruleActions": [
    {
      "_entity": "ruleAction",
      "ruleId": "text",
      "actionSeqId": "text",
      "actionTypeEnumId": "text",
      "fieldName": "text",
      "fieldValue": "text",
      "sequenceNum": 1,
      "createdDate": "2025-07-11T16:10:43.850Z",
      "lastUpdatedStamp": "2025-07-11T16:10:43.850Z",
      "ruleActionType": {
        "_entity": "enums",
        "enumId": "text",
        "enumTypeId": "text",
        "parentEnumId": "text",
        "enumCode": "text",
        "sequenceNum": 1,
        "description": "text",
        "optionValue": "text",
        "optionIndicator": "text",
        "relatedEnumId": "text",
        "relatedEnumTypeId": "text",
        "statusFlowId": "text",
        "enumName": "text",
        "primaryEnumerationGroupId": "text",
        "lastUpdatedStamp": "2025-07-11T16:10:43.850Z"
      }
    }
  ]
}

store DecisionRule (master: default)

post

Represents a rule, defining conditions and actions logic.

Authorizations

basicAuthapi_key

Path parameters

ruleIdstringRequired

Unique identifier for the rule.

Body

application/jsonmultipart/form-data

_entitystringOptionalDefault: rule

ruleIdstringOptional

ruleGroupIdstringOptional

ruleNamestringOptional

statusIdstringOptional

sequenceNumnumber · int64Optional

createdDatestring · date-timeOptional

createdByUserstringOptional

lastUpdatedStampstring · date-timeOptional

Responses

200

Success

application/json

401

Authentication required

403

Access Forbidden (no authz)

404

Value Not Found

429

Too Many Requests (tarpit)

500

General Error

post

HTTPcURLJavaScriptPython

POST /rest/s1/available-to-promise/decisionRules/{ruleId} HTTP/1.1
Host: dev-maarg.hotwax.io
Authorization: Basic username:password
Content-Type: application/json
Accept: */*
Content-Length: 1476

{
  "_entity": "rule",
  "ruleId": "text",
  "ruleGroupId": "text",
  "ruleName": "text",
  "statusId": "text",
  "sequenceNum": 1,
  "createdDate": "2025-07-11T16:10:43.850Z",
  "createdByUser": "text",
  "lastUpdatedStamp": "2025-07-11T16:10:43.850Z",
  "ruleConditions": [
    {
      "_entity": "ruleCondition",
      "ruleId": "text",
      "conditionSeqId": "text",
      "conditionTypeEnumId": "text",
      "fieldName": "text",
      "operator": "text",
      "fieldValue": "text",
      "sequenceNum": 1,
      "createdDate": "2025-07-11T16:10:43.850Z",
      "lastUpdatedStamp": "2025-07-11T16:10:43.850Z",
      "ruleConditionType": {
        "_entity": "enums",
        "enumId": "text",
        "enumTypeId": "text",
        "parentEnumId": "text",
        "enumCode": "text",
        "sequenceNum": 1,
        "description": "text",
        "optionValue": "text",
        "optionIndicator": "text",
        "relatedEnumId": "text",
        "relatedEnumTypeId": "text",
        "statusFlowId": "text",
        "enumName": "text",
        "primaryEnumerationGroupId": "text",
        "lastUpdatedStamp": "2025-07-11T16:10:43.850Z"
      }
    }
  ],
  "ruleActions": [
    {
      "_entity": "ruleAction",
      "ruleId": "text",
      "actionSeqId": "text",
      "actionTypeEnumId": "text",
      "fieldName": "text",
      "fieldValue": "text",
      "sequenceNum": 1,
      "createdDate": "2025-07-11T16:10:43.850Z",
      "lastUpdatedStamp": "2025-07-11T16:10:43.850Z",
      "ruleActionType": {
        "_entity": "enums",
        "enumId": "text",
        "enumTypeId": "text",
        "parentEnumId": "text",
        "enumCode": "text",
        "sequenceNum": 1,
        "description": "text",
        "optionValue": "text",
        "optionIndicator": "text",
        "relatedEnumId": "text",
        "relatedEnumTypeId": "text",
        "statusFlowId": "text",
        "enumName": "text",
        "primaryEnumerationGroupId": "text",
        "lastUpdatedStamp": "2025-07-11T16:10:43.850Z"
      }
    }
  ]
}

application/jsonmultipart/form-data

{
  "_entity": "rule.PK",
  "ruleId": "text"
}

delete RuleCondition

delete

Defines conditions used in rules.

Authorizations

basicAuthapi_key

Path parameters

ruleIdstringRequired

Unique identifier for the rule.

Body

application/jsonmultipart/form-data

_entitystringOptionalDefault: ruleCondition.PK

ruleIdstringOptional

conditionSeqIdstringOptional

Responses

401

Authentication required

403

Access Forbidden (no authz)

404

Value Not Found

429

Too Many Requests (tarpit)

500

General Error

delete

HTTPcURLJavaScriptPython

DELETE /rest/s1/available-to-promise/decisionRules/{ruleId}/conditions HTTP/1.1
Host: dev-maarg.hotwax.io
Authorization: Basic username:password
Content-Type: application/json
Accept: */*
Content-Length: 70

{
  "_entity": "ruleCondition.PK",
  "ruleId": "text",
  "conditionSeqId": "text"
}

application/jsonmultipart/form-data

No content

delete RuleAction

delete

Specifies actions to be performed when a rule is triggered during processing.

Authorizations

basicAuthapi_key

Path parameters

ruleIdstringRequired

Unique identifier for the rule.

Body

application/jsonmultipart/form-data

_entitystringOptionalDefault: ruleAction.PK

ruleIdstringOptional

actionSeqIdstringOptional

Responses

401

Authentication required

403

Access Forbidden (no authz)

404

Value Not Found

429

Too Many Requests (tarpit)

500

General Error

delete

HTTPcURLJavaScriptPython

DELETE /rest/s1/available-to-promise/decisionRules/{ruleId}/actions HTTP/1.1
Host: dev-maarg.hotwax.io
Authorization: Basic username:password
Content-Type: application/json
Accept: */*
Content-Length: 64

{
  "_entity": "ruleAction.PK",
  "ruleId": "text",
  "actionSeqId": "text"
}

application/jsonmultipart/form-data

No content