HomeGlossary

RuleGroups

ruleGroups

list RuleGroup (master: default)

get

Represents a group for organizing rules.

Authorizations
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

ruleGroupIdstringOptional

Unique identifier for the group

productStoreIdstringOptional

Unique identifier for the product store

groupNamestringOptional

Name of the group.

groupTypeEnumIdstringOptional

Type of the group.

statusIdstringOptional

Status identifier for the rule group.

sequenceNumnumber · int64Optional

Sequence number for ordering.

jobNamestringOptional

moqui.service.job.Service reference

descriptionstringOptional

Description or additional information about the group.

createdByUserstringOptional

User login ID of the creator

createdDatestring · date-timeOptional

Date and time when the group was created

lastModifiedDatestring · date-timeOptional

Date and time when the group was updated

lastUpdatedStampstring · date-timeOptional
Responses
200
Success
application/json
get
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-07-11T20:47:48.103Z",
    "lastModifiedDate": "2025-07-11T20:47:48.103Z",
    "lastUpdatedStamp": "2025-07-11T20:47:48.103Z",
    "decisionRules": [
      {
        "_entity": "rule",
        "ruleId": "text",
        "ruleGroupId": "text",
        "ruleName": "text",
        "statusId": "text",
        "sequenceNum": 1,
        "createdDate": "2025-07-11T20:47:48.103Z",
        "createdByUser": "text",
        "lastUpdatedStamp": "2025-07-11T20:47:48.103Z"
      }
    ]
  }
]

store RuleGroup

post

Represents a group for organizing rules.

Authorizations
Body
_entitystringOptionalDefault: ruleGroup
ruleGroupIdstringOptional
productStoreIdstringOptional
groupNamestringOptional
groupTypeEnumIdstringOptional
statusIdstringOptional
sequenceNumnumber · int64Optional
jobNamestringOptional
descriptionstringOptional
createdByUserstringOptional
createdDatestring · date-timeOptional
lastModifiedDatestring · date-timeOptional
lastUpdatedStampstring · date-timeOptional
Responses
200
Success
application/json
post
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-07-11T20:47:48.103Z",
  "lastModifiedDate": "2025-07-11T20:47:48.103Z",
  "lastUpdatedStamp": "2025-07-11T20:47:48.103Z"
}
{
  "_entity": "ruleGroup.PK",
  "ruleGroupId": "text"
}

one RuleGroup (master: default)

get

Represents a group for organizing rules.

Authorizations
Path parameters
ruleGroupIdstringRequired

Unique identifier for the group

Responses
200
Success
application/json
get
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-07-11T20:47:48.103Z",
  "lastModifiedDate": "2025-07-11T20:47:48.103Z",
  "lastUpdatedStamp": "2025-07-11T20:47:48.103Z",
  "decisionRules": [
    {
      "_entity": "rule",
      "ruleId": "text",
      "ruleGroupId": "text",
      "ruleName": "text",
      "statusId": "text",
      "sequenceNum": 1,
      "createdDate": "2025-07-11T20:47:48.103Z",
      "createdByUser": "text",
      "lastUpdatedStamp": "2025-07-11T20:47:48.103Z"
    }
  ]
}

store RuleGroup (master: default)

post

Represents a group for organizing rules.

Authorizations
Path parameters
ruleGroupIdstringRequired

Unique identifier for the group

Body
_entitystringOptionalDefault: ruleGroup
ruleGroupIdstringOptional
productStoreIdstringOptional
groupNamestringOptional
groupTypeEnumIdstringOptional
statusIdstringOptional
sequenceNumnumber · int64Optional
jobNamestringOptional
descriptionstringOptional
createdByUserstringOptional
createdDatestring · date-timeOptional
lastModifiedDatestring · date-timeOptional
lastUpdatedStampstring · date-timeOptional
Responses
200
Success
application/json
post
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-07-11T20:47:48.103Z",
  "lastModifiedDate": "2025-07-11T20:47:48.103Z",
  "lastUpdatedStamp": "2025-07-11T20:47:48.103Z",
  "decisionRules": [
    {
      "_entity": "rule",
      "ruleId": "text",
      "ruleGroupId": "text",
      "ruleName": "text",
      "statusId": "text",
      "sequenceNum": 1,
      "createdDate": "2025-07-11T20:47:48.103Z",
      "createdByUser": "text",
      "lastUpdatedStamp": "2025-07-11T20:47:48.103Z"
    }
  ]
}
{
  "_entity": "ruleGroup.PK",
  "ruleGroupId": "text"
}

list DecisionRule

get

Represents a rule, defining conditions and actions logic.

Authorizations
Path parameters
ruleGroupIdstringRequired

Unique identifier for the rule group.

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.

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
get
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-07-11T20:47:48.103Z",
    "createdByUser": "text",
    "lastUpdatedStamp": "2025-07-11T20:47:48.103Z"
  }
]

scheduleNow RuleGroup

post
Authorizations
Path parameters
ruleGroupIdstringRequired
Responses
200
Success
application/json
post
POST /rest/s1/available-to-promise/ruleGroups/{ruleGroupId}/runNow HTTP/1.1
Host: dev-maarg.hotwax.io
Authorization: Basic username:password
Accept: */*

{
  "jobRunId": "text"
}

get RuleGroupSchedule

get
Authorizations
Path parameters
ruleGroupIdstringRequired
Responses
200
Success
application/json
get
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-07-11T20:47:48.103Z",
    "thruDate": "2025-07-11T20:47:48.103Z",
    "repeatCount": 1,
    "paused": "text",
    "expireLockTime": 1,
    "minRetryTime": 1,
    "priority": 1,
    "parentJobName": "text",
    "jobTypeEnumId": "text",
    "permissionGroupId": "text",
    "instanceOfProductId": "text",
    "lastUpdatedStamp": "2025-07-11T20:47:48.103Z"
  }
}

store RuleGroupSchedule

post
Authorizations
Path parameters
ruleGroupIdstringRequired
Body
ruleGroupIdstringRequired
systemMessageRemoteIdstringRequired
transactionTimeoutinteger · int64Optional
topicstringOptional
localOnlystringOptional
cronExpressionstringOptional
fromDatestring · date-timeOptional
thruDatestring · date-timeOptional
repeatCountinteger · int64Optional
pausedstringOptional
expireLockTimeinteger · int64Optional
minRetryTimeinteger · int64Optional
priorityinteger · int64Optional
parentJobNamestringOptional
jobTypeEnumIdstringOptional
permissionGroupIdstringOptional
instanceOfProductIdstringOptional
lastUpdatedStampstring · date-timeOptional
Responses
200
Success
application/json
post
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-07-11T20:47:48.103Z",
  "thruDate": "2025-07-11T20:47:48.103Z",
  "repeatCount": 1,
  "paused": "text",
  "expireLockTime": 1,
  "minRetryTime": 1,
  "priority": 1,
  "parentJobName": "text",
  "jobTypeEnumId": "text",
  "permissionGroupId": "text",
  "instanceOfProductId": "text",
  "lastUpdatedStamp": "2025-07-11T20:47:48.103Z"
}
{
  "jobName": "text"
}

list RuleGroupRun

get

Represents the execution and results of rule group runs, including information about errors and outcomes.

Authorizations
Path parameters
ruleGroupIdstringRequired

Unique identifier for the rule group.

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

ruleGroupRunIdstringOptional

Unique identifier for the rule group run.

productStoreIdstringOptional

Unique identifier for the product store.

createdByUserstringOptional

User login ID of the creator.

hasErrorstringOptional

Indicator for the presence of errors.

startDatestring · date-timeOptional

Start date of the rule group run.

endDatestring · date-timeOptional

End date of the rule group run.

ruleGroupRunResultstringOptional

Result or outcome of the rule group run.

lastUpdatedStampstring · date-timeOptional
Responses
200
Success
application/json
get
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-07-11T20:47:48.103Z",
    "endDate": "2025-07-11T20:47:48.103Z",
    "ruleGroupRunResult": "text",
    "lastUpdatedStamp": "2025-07-11T20:47:48.103Z"
  }
]
PreviousServiceJobRunsNextDecisionRules

Was this helpful?