Scheduled checklists

Create checklist generation rule#

You can create a rule for generating checklists, set the period for the rule to work, frequency and time of execution.

POST
/checklist/rule

Request body:

Attribute	Type	Description	Nullable
name	String	Name of the rule	false
active	Boolean	Whether the rule is active	false
needReview	Boolean	Whether the generated checklist requires a review	false
generationType	String	Available 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
dateFrom	LocalDateTime	Date and time from which the rule is active	false
dateTo	LocalDateTime	Date and time until which the rule is active	false
scheduledTime	Time	Time of day when the checklist is generated	false
shops	List of Integers	Identifiers of stores	false
regions	List of Integers	Identifiers of regions	false
divisions	List of Integers	Identifiers of divisions	false
resolverLevel	String	Organizational level of the resolver	false
businessDirectionIds	List of Integers	Identifiers of business directions	false
catalogValues	List of Integers	Identifiers of catalog values used as an additional store filter	false
templates	List of Integers	Identifiers of checklist templates	false
dayOfMonth	List of Integers	Days of the month on which to generate the checklist. Used when `generationType` is not `weekly`; alternatively use `days`	false
dayOfWeek	List of Integers	Days of the week (1 — Monday … 7 — Sunday) on which to generate the checklist. Used when `generationType` is `weekly`; alternatively use `days`	false
months	List of Integers	Month numbers on which to generate the checklist. Used for `quarterly` / `halfYearly` generation types	false
days	List of Integers	Shorthand for `dayOfWeek` / `dayOfMonth`: automatically routed to the right field based on `generationType`	false

Response

Returns a Generation rule object

Examples

curl --request POST https://api.qvalon.com/v1/checklist/rule \
--header 'Authorization: Bearer <your_token>' \
-d '{"name":"rule 2","active":true,"dateTo":null,"dateFrom":"2022-08-05T00:00:00.000Z","needReview":false,"scheduledTime":"13:00","shops":[665],"regions":[],"divisions":[],"businessDirectionIds":[1003],"resolverLevel":"SHOP","templates":[629],"catalogValues":[],"generationType":"weekly","dayOfWeek":[2,4]}'

200 OK

{
  "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": "Shoes shop",
      "sap": "002 shop",
      "active": true
    }
  ],
  "regions": [],
  "divisions": [],
  "catalogValues": [],
  "templates": [
    {
      "id": 629,
      "name": "Shoes template",
      "active": true
    }
  ],
  "businessDirectionIds": [
    1003
  ],
  "resolverLevel": "SHOP",
  "dayOfMonth": [],
  "dayOfWeek": [
    2,
    4
  ],
  "months": [],
  "days": [
    2,
    4
  ]
}