Skip to content

V1.0 Tasks data model

Tasks data model

Data structure of response file obtained from async endpoint:

Field Format Description
uuid string Unique identifier of the flat process step joint with task
quality_manual_uuid string Unique identifier of quality manual
quality_manual_version_title string Title of quality manual
quality_manual_version_uuid string Version of the quality manual
process_control_title string Title of the specific process control in the quality manual
process_control_uuid string Unique identifier of the specific process control in the quality manual
process_ctrl_category_title string Title of the specific process control category in the quality manual (e.g. stationary monitoring)
process_ctrl_category_uuid string Unique identifier of the process control category
task_title string Name of the task
task_uuid string Unique identifier of the task
task_execution_uuid string Unique identifier of the task execution
task_type string Task type (e.g. ALARM, ADHOC, PLANNED or FLEXIBLE_PLANNED)
has_corrective_action boolean One of the process steps of this task execution was marked as correctiveAction
task_status string Status of the task execution (e.g. PAUSED or FINISHED)
shift_uuid string Unique identifier of shift the task was scheduled for (null for FLEXIBLE_PLANNED tasks)
shift_begin string Timepoint of the shift start in “YYYY-MM-DDThh:mm:ssZ“
shift_end string Timepoint of the shift end in “YYYY-MM-DDThh:mm:ssZ“
task_timestamp_start string Timepoint of the start of the task execution in “YYYY-MM-DDThh:mm:ssZ“
task_timestamp_end string Timepoint of the end of the task execution in “YYYY-MM-DDThh:mm:ssZ“
tenant_uuid string Unique identifier of the tenant
site_name string Name of the restaurant/location which executed the task
site_number string Optional restaurant/location identifier
app_version string Version of the installed app on the control unit
serial_no_tablet string Serial number of tablet the task was executed
process_step_instruction string Detail description of a step of a task
process_step_corrective_action boolean "Is this step of the task a corrective action“ flag
marked_as_deleted boolean Detail information for a process step (e.g manual temperature measurements)
username string Username of the user who executed the task
user_uuid string Unique identifier of user who executed the task
process_step_type string Definition of process step type (e.g. make comment, take photo, input number)
process_step_uuid string Unique identifier of process step
sequence_no int Sequence number of process step (1 is the first step of the task)
timestamp string Timestamp the process step was reached
alarm_log_uuid string Unique identifier of the alarm (map alarm_log_uuid to uuid of Alarms api)
content string Context information of the task/process step
parameters string Context information of the task/process step
context string Context information of the task/process step
processed_at string UTC timestamp of the time the data was processed in the API backend in format “YYYY-MM-DDThh:mm:ssZ”