RuleGroups
ruleGroups
Represents a group for organizing rules.
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 group
Unique identifier for the product store
Name of the group.
Type of the group.
Status identifier for the rule group.
Sequence number for ordering.
moqui.service.job.Service reference
Description or additional information about the group.
User login ID of the creator
Date and time when the group was created
Date and time when the group was updated
Success
Authentication required
Access Forbidden (no authz)
Value Not Found
Too Many Requests (tarpit)
General Error
GET /rest/s1/available-to-promise/ruleGroups HTTP/1.1
Host: dev-maarg.hotwax.io
Authorization: Basic username:password
Accept: */*
[
{
"_entity": "ruleGroup",
"ruleGroupId": "text",
"productStoreId": "text",
"groupName": "text",
"groupTypeEnumId": "text",
"statusId": "text",
"sequenceNum": 1,
"jobName": "text",
"description": "text",
"createdByUser": "text",
"createdDate": "2025-08-30T00:59:54.770Z",
"lastModifiedDate": "2025-08-30T00:59:54.770Z",
"lastUpdatedStamp": "2025-08-30T00:59:54.770Z",
"decisionRules": [
{
"_entity": "rule",
"ruleId": "text",
"ruleGroupId": "text",
"ruleName": "text",
"statusId": "text",
"sequenceNum": 1,
"createdDate": "2025-08-30T00:59:54.770Z",
"createdByUser": "text",
"lastUpdatedStamp": "2025-08-30T00:59:54.770Z"
}
]
}
]Represents a group for organizing rules.
ruleGroupSuccess
Authentication required
Access Forbidden (no authz)
Value Not Found
Too Many Requests (tarpit)
General Error
POST /rest/s1/available-to-promise/ruleGroups HTTP/1.1
Host: dev-maarg.hotwax.io
Authorization: Basic username:password
Content-Type: application/json
Accept: */*
Content-Length: 340
{
"_entity": "ruleGroup",
"ruleGroupId": "text",
"productStoreId": "text",
"groupName": "text",
"groupTypeEnumId": "text",
"statusId": "text",
"sequenceNum": 1,
"jobName": "text",
"description": "text",
"createdByUser": "text",
"createdDate": "2025-08-30T00:59:54.770Z",
"lastModifiedDate": "2025-08-30T00:59:54.770Z",
"lastUpdatedStamp": "2025-08-30T00:59:54.770Z"
}{
"_entity": "ruleGroup.PK",
"ruleGroupId": "text"
}Represents a group for organizing rules.
Unique identifier for the group
Success
Authentication required
Access Forbidden (no authz)
Value Not Found
Too Many Requests (tarpit)
General Error
GET /rest/s1/available-to-promise/ruleGroups/{ruleGroupId} HTTP/1.1
Host: dev-maarg.hotwax.io
Authorization: Basic username:password
Accept: */*
{
"_entity": "ruleGroup",
"ruleGroupId": "text",
"productStoreId": "text",
"groupName": "text",
"groupTypeEnumId": "text",
"statusId": "text",
"sequenceNum": 1,
"jobName": "text",
"description": "text",
"createdByUser": "text",
"createdDate": "2025-08-30T00:59:54.770Z",
"lastModifiedDate": "2025-08-30T00:59:54.770Z",
"lastUpdatedStamp": "2025-08-30T00:59:54.770Z",
"decisionRules": [
{
"_entity": "rule",
"ruleId": "text",
"ruleGroupId": "text",
"ruleName": "text",
"statusId": "text",
"sequenceNum": 1,
"createdDate": "2025-08-30T00:59:54.770Z",
"createdByUser": "text",
"lastUpdatedStamp": "2025-08-30T00:59:54.770Z"
}
]
}Represents a group for organizing rules.
Unique identifier for the group
ruleGroupSuccess
Authentication required
Access Forbidden (no authz)
Value Not Found
Too Many Requests (tarpit)
General Error
POST /rest/s1/available-to-promise/ruleGroups/{ruleGroupId} HTTP/1.1
Host: dev-maarg.hotwax.io
Authorization: Basic username:password
Content-Type: application/json
Accept: */*
Content-Length: 576
{
"_entity": "ruleGroup",
"ruleGroupId": "text",
"productStoreId": "text",
"groupName": "text",
"groupTypeEnumId": "text",
"statusId": "text",
"sequenceNum": 1,
"jobName": "text",
"description": "text",
"createdByUser": "text",
"createdDate": "2025-08-30T00:59:54.770Z",
"lastModifiedDate": "2025-08-30T00:59:54.770Z",
"lastUpdatedStamp": "2025-08-30T00:59:54.770Z",
"decisionRules": [
{
"_entity": "rule",
"ruleId": "text",
"ruleGroupId": "text",
"ruleName": "text",
"statusId": "text",
"sequenceNum": 1,
"createdDate": "2025-08-30T00:59:54.770Z",
"createdByUser": "text",
"lastUpdatedStamp": "2025-08-30T00:59:54.770Z"
}
]
}{
"_entity": "ruleGroup.PK",
"ruleGroupId": "text"
}Represents a rule, defining conditions and actions logic.
Unique identifier for the rule group.
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.
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/ruleGroups/{ruleGroupId}/rules 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-30T00:59:54.770Z",
"createdByUser": "text",
"lastUpdatedStamp": "2025-08-30T00:59:54.770Z"
}
]Success
Authentication required
Access Forbidden (no authz)
Too Many Requests (tarpit)
General Error
POST /rest/s1/available-to-promise/ruleGroups/{ruleGroupId}/runNow HTTP/1.1
Host: dev-maarg.hotwax.io
Authorization: Basic username:password
Accept: */*
{
"jobRunId": "text"
}Success
Authentication required
Access Forbidden (no authz)
Too Many Requests (tarpit)
General Error
GET /rest/s1/available-to-promise/ruleGroups/{ruleGroupId}/schedule HTTP/1.1
Host: dev-maarg.hotwax.io
Authorization: Basic username:password
Accept: */*
{
"schedule": {
"jobName": "text",
"description": "text",
"serviceName": "text",
"transactionTimeout": 1,
"topic": "text",
"localOnly": "text",
"cronExpression": "text",
"fromDate": "2025-08-30T00:59:54.770Z",
"thruDate": "2025-08-30T00:59:54.770Z",
"repeatCount": 1,
"paused": "text",
"expireLockTime": 1,
"minRetryTime": 1,
"priority": 1,
"parentJobName": "text",
"jobTypeEnumId": "text",
"permissionGroupId": "text",
"instanceOfProductId": "text",
"lastUpdatedStamp": "2025-08-30T00:59:54.770Z"
}
}Success
Authentication required
Access Forbidden (no authz)
Too Many Requests (tarpit)
General Error
POST /rest/s1/available-to-promise/ruleGroups/{ruleGroupId}/schedule HTTP/1.1
Host: dev-maarg.hotwax.io
Authorization: Basic username:password
Content-Type: application/json
Accept: */*
Content-Length: 439
{
"ruleGroupId": "text",
"systemMessageRemoteId": "text",
"transactionTimeout": 1,
"topic": "text",
"localOnly": "text",
"cronExpression": "text",
"fromDate": "2025-08-30T00:59:54.770Z",
"thruDate": "2025-08-30T00:59:54.770Z",
"repeatCount": 1,
"paused": "text",
"expireLockTime": 1,
"minRetryTime": 1,
"priority": 1,
"parentJobName": "text",
"jobTypeEnumId": "text",
"permissionGroupId": "text",
"instanceOfProductId": "text",
"lastUpdatedStamp": "2025-08-30T00:59:54.770Z"
}{
"jobName": "text"
}Represents the execution and results of rule group runs, including information about errors and outcomes.
Unique identifier for the rule group.
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 group run.
Unique identifier for the product store.
User login ID of the creator.
Indicator for the presence of errors.
Start date of the rule group run.
End date of the rule group run.
Result or outcome of the rule group run.
Success
Authentication required
Access Forbidden (no authz)
Value Not Found
Too Many Requests (tarpit)
General Error
GET /rest/s1/available-to-promise/ruleGroups/{ruleGroupId}/ruleGroupRuns HTTP/1.1
Host: dev-maarg.hotwax.io
Authorization: Basic username:password
Accept: */*
[
{
"_entity": "ruleGroupRuns",
"ruleGroupRunId": "text",
"ruleGroupId": "text",
"productStoreId": "text",
"createdByUser": "text",
"hasError": "text",
"startDate": "2025-08-30T00:59:54.770Z",
"endDate": "2025-08-30T00:59:54.770Z",
"ruleGroupRunResult": "text",
"lastUpdatedStamp": "2025-08-30T00:59:54.770Z"
}
]Was this helpful?