DecisionRules
decisionRules
Represents a rule, defining conditions and actions logic.
Page number to return, starting with zero
Number of records per page (default 100)
Field name to order by (or comma separated names)
If true don't limit page size (no pagination)
Levels of dependent child records to include
Unique identifier for the rule.
Unique identifier for the rule group.
Name of the rule.
Status of the rule.
Sequence number for ordering.
Date and time when the rule was created.
User login ID of the creator.
Success
Authentication required
Access Forbidden (no authz)
Value Not Found
Too Many Requests (tarpit)
General Error
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-08-08T09:00:27.401Z",
"createdByUser": "text",
"lastUpdatedStamp": "2025-08-08T09:00:27.401Z",
"ruleConditions": [
{
"_entity": "ruleCondition",
"ruleId": "text",
"conditionSeqId": "text",
"conditionTypeEnumId": "text",
"fieldName": "text",
"operator": "text",
"fieldValue": "text",
"sequenceNum": 1,
"createdDate": "2025-08-08T09:00:27.401Z",
"lastUpdatedStamp": "2025-08-08T09:00:27.401Z",
"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-08-08T09:00:27.401Z"
}
}
],
"ruleActions": [
{
"_entity": "ruleAction",
"ruleId": "text",
"actionSeqId": "text",
"actionTypeEnumId": "text",
"fieldName": "text",
"fieldValue": "text",
"sequenceNum": 1,
"createdDate": "2025-08-08T09:00:27.401Z",
"lastUpdatedStamp": "2025-08-08T09:00:27.401Z",
"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-08-08T09:00:27.401Z"
}
}
]
}
]
Represents a rule, defining conditions and actions logic.
rule
Success
Authentication required
Access Forbidden (no authz)
Value Not Found
Too Many Requests (tarpit)
General Error
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-08-08T09:00:27.401Z",
"createdByUser": "text",
"lastUpdatedStamp": "2025-08-08T09:00:27.401Z"
}
{
"_entity": "rule.PK",
"ruleId": "text"
}
Represents a rule, defining conditions and actions logic.
Unique identifier for the rule.
Success
Authentication required
Access Forbidden (no authz)
Value Not Found
Too Many Requests (tarpit)
General Error
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-08-08T09:00:27.401Z",
"createdByUser": "text",
"lastUpdatedStamp": "2025-08-08T09:00:27.401Z",
"ruleConditions": [
{
"_entity": "ruleCondition",
"ruleId": "text",
"conditionSeqId": "text",
"conditionTypeEnumId": "text",
"fieldName": "text",
"operator": "text",
"fieldValue": "text",
"sequenceNum": 1,
"createdDate": "2025-08-08T09:00:27.401Z",
"lastUpdatedStamp": "2025-08-08T09:00:27.401Z",
"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-08-08T09:00:27.401Z"
}
}
],
"ruleActions": [
{
"_entity": "ruleAction",
"ruleId": "text",
"actionSeqId": "text",
"actionTypeEnumId": "text",
"fieldName": "text",
"fieldValue": "text",
"sequenceNum": 1,
"createdDate": "2025-08-08T09:00:27.401Z",
"lastUpdatedStamp": "2025-08-08T09:00:27.401Z",
"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-08-08T09:00:27.401Z"
}
}
]
}
Represents a rule, defining conditions and actions logic.
Unique identifier for the rule.
rule
Success
Authentication required
Access Forbidden (no authz)
Value Not Found
Too Many Requests (tarpit)
General Error
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-08-08T09:00:27.401Z",
"createdByUser": "text",
"lastUpdatedStamp": "2025-08-08T09:00:27.401Z",
"ruleConditions": [
{
"_entity": "ruleCondition",
"ruleId": "text",
"conditionSeqId": "text",
"conditionTypeEnumId": "text",
"fieldName": "text",
"operator": "text",
"fieldValue": "text",
"sequenceNum": 1,
"createdDate": "2025-08-08T09:00:27.401Z",
"lastUpdatedStamp": "2025-08-08T09:00:27.401Z",
"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-08-08T09:00:27.401Z"
}
}
],
"ruleActions": [
{
"_entity": "ruleAction",
"ruleId": "text",
"actionSeqId": "text",
"actionTypeEnumId": "text",
"fieldName": "text",
"fieldValue": "text",
"sequenceNum": 1,
"createdDate": "2025-08-08T09:00:27.401Z",
"lastUpdatedStamp": "2025-08-08T09:00:27.401Z",
"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-08-08T09:00:27.401Z"
}
}
]
}
{
"_entity": "rule.PK",
"ruleId": "text"
}
Defines conditions used in rules.
Unique identifier for the rule.
ruleCondition.PK
Authentication required
Access Forbidden (no authz)
Value Not Found
Too Many Requests (tarpit)
General Error
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"
}
No content
Specifies actions to be performed when a rule is triggered during processing.
Unique identifier for the rule.
ruleAction.PK
Authentication required
Access Forbidden (no authz)
Value Not Found
Too Many Requests (tarpit)
General Error
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"
}
No content
Was this helpful?