The fixed value sets used by the compliance task endpoints.
The compliance task endpoints share several fixed value sets. They are listed here once; the endpoint pages and the
field descriptions link to the section they need instead of repeating the values.
Critical control points
CCP types
The type field is a fixed set of values:
type | Name |
|---|---|
| 1 | Delivery & Receipt |
| 2 | Storage |
| 3 | Preparation |
| 4 | Processing |
| 5 | Cooking |
| 6 | Reheating |
| 7 | Service |
| 8 | Food Display |
| 9 | Waste |
| 10 | Facility |
| 11 | Other |
Mitigation policy
The mitigation_policy field defines whether a corrective action is required when a related task fails:
mitigation_policy | Name |
|---|---|
| 0 | Not required |
| 1 | Optional |
| 2 | Required |
Task templates
Template types
The type field is a fixed set of slugs. It also determines which keys a template's type_specific object holds:
type | Name | type_specific keys |
|---|---|---|
temperature_check | Temperature check | ccp, temperatures |
checklist_task | Checklist task | ccp, checklist |
general_task | General task | none ({}) |
cleaning_sanitation | Cleaning & Sanitation | ccp |
order | Order | none ({}) |
count | Count | none ({}) |
packaging | Packaging | ccp |
maintenance | Maintenance | ccp |
waste_management | Waste Management | ccp |
pest_control | Pest Control | ccp |
facility_management | Facility Management | ccp |
stock_management | Stock Management | ccp |
chemical_control | Chemical Control | ccp |
training | Training | ccp |
traceability_recall | Traceability & Recall | ccp |
The calendar endpoint is the exception: the template it embeds carries ccp only, never temperatures or
checklist. Fetch the occurrence or the template itself for those.
Recurrence
recurrence.frequency is a fixed set of slugs. All keys of recurrence are always present; the ones that do not
apply to the frequency are null:
frequency | Name | Applicable fields |
|---|---|---|
once | Once | start_date, start_time |
daily | Daily | start_date, start_time, end_date, interval |
weekly | Weekly | start_date, start_time, end_date, interval, weekdays |
monthly | Monthly | start_date, start_time, end_date, interval, day_of_month |
yearly | Yearly | start_date, start_time, end_date, interval, day_of_month, month_of_year |
weekdays values: Monday, Tuesday, Wednesday, Thursday, Friday, Saturday, Sunday.
Task occurrences
Completion result
completion.result | Meaning |
|---|---|
ok | The task was completed successfully |
nok | The task was completed with a failed outcome |
null | The task is not completed yet (planned or draft) |
