Scheduled checklists

Create checklist generation rule#

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

POST
/checklist/rule

Request body:

Attribute	Type	Description	Nullable
name	String	Rule name	false
active	Boolean	Flag indicating rule is active	false
needReview	Boolean	The need for 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	Rule start time	false
dateTo	LocalDateTime	Rule end time	false
scheduledTime	LocalDateTime	Checklist generation time	false
shops	List of Integers	Shops ids	false
regions	List of Integers	regions ids	false
divisions	List of Integers	divisions ids	false
resolverLevel	String	Level of resolver	false
businessDirectionIds	List of Integers	Business direction ids	false
catalogValues	List of Integers		false
templates	List of Integers	Template ids	false
dayOfMonth	List of Integers	Template ids	false
dayOfWeek	List of Integers	Day of week	false
months	List of Integers	Months numbers	false
days	List of Integers	Days	false

Response

Returns Checklist template 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
    ]
  }
]

Delete task#

Returns code status

DELETE
/tasks-manual/{id}

Examples

curl --request DELETE https://api.qvalon.com/v1/tasks-manual/162 \
--header 'Authorization: Bearer <your_token>'

200 OK

{}