Compliance Task Reference Values

The compliance task endpoints share several 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.

Most of these sets are fixed. Two can grow: the type of a critical control point and the type of a task template both gain values as new ones ship, and a new value is not treated as a breaking change to this API. Treat a type you do not recognise as valid rather than failing on it.

Critical control points

CCP types

The type of a critical control point:

`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 of a task template. 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`, `interval`
`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.

On write, a field that is not applicable to the frequency is rejected rather than ignored, and the applicable ones are not all optional: weekly requires weekdays, monthly requires day_of_month, and yearly requires both day_of_month and month_of_year. interval defaults to 1, and a value above 1 is accepted only for weekly, monthly and yearly — once and daily take 1 and nothing else.

Task custom fields

Custom field types

The type of a task custom field is a fixed set of values. It decides whether the definition carries an options list:

`type`	Name	`options`
`choices`	Single Choice	The allowed values
`multi`	Multi Choice	The allowed values
`text`	Free Text	`null`
`long_text`	Long Free Text	`null`

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)