Skip to main content

Generation rule

The generation rule is a helper object for setting the frequency of rule execution


AttributeTypeDescriptionNullable
idStringIdentifier of checklist generation rulefalse
nameStringRule namefalse
activeBoleanFlag indicating rule is activefalse
needReviewBoleanThe need for a reviewfalse
generationTypeStringAvailable types:
daily - daily
weekly - on certain days of the week
monthly - on specified days of the month
lastDayOfMonth - on last day of the month
quarterly - quarterly
halfYearly - half-yearly
false
dateFromLocalDateTimeRule start timefalse
dateToLocalDateTimeRule end timefalse
scheduledTimeLocalDateTimeChecklist generation timefalse
lastGenerationDateLocalDateTimeChecklist last generation timefalse
shopsList of IntegersShops idsfalse
regionsList of Integersregions idsfalse
divisionsList of Integersdivisions idsfalse
resolverLevelStringLevel of resolver false
businessDirectionIdsList of IntegersBusiness direction idsfalse
catalogValuesList of Integersfalse
templatesList of IntegersTemplate idsfalse
dayOfMonthList of IntegersTemplate idsfalse
dayOfWeekList of IntegersDay of weekfalse
monthsList of IntegersMonths numbersfalse
daysList of IntegersDaysfalse
Example:
{
"id": 7,
"name": "rule 2",
"active": true,
"needReview": false,
"generationType": "weekly",
"dateFrom": "2022-08-05T00:00:00.000Z",
"dateTo": null,
"scheduledTime": "13:00",
"lastGenerationDate": null,
"shops": [
{
"id": 665,
"locality": "Small shop",
"sap": "002 London",
"active": true
}
],
"regions": [],
"divisions": [],
"catalogValues": [],
"templates": [
{
"id": 629,
"name": "Good template",
"active": true
}
],
"businessDirectionIds": [
1003
],
"resolverLevel": "SHOP",
"dayOfMonth": [],
"dayOfWeek": [
2,
4
],
"months": [],
"days": [
2,
4
]
}