ServiceAssignmentStatusDefinition DTO v17

Defines the meaning of the service assignment status.

Field Name Type Required Constraint Reference Description
changeable Boolean Required Specifies whether the definition is changeable or not.
chargeable Boolean Optional
checklistCategoryName String Optional length >= 1 & length <= 255 Points the correct ChecklistInstance (together with {@link #checklistTemplateName}, {@link #checklistTemplateTag}) to be used for this step's screen (when {@link #screenType} is {@link ScreenType#CHECKLIST}).
checklistTemplateName String Optional length >= 1 & length <= 255 Points the correct ChecklistInstance (together with {@link #checklistCategoryName}, {@link #checklistTemplateTag}) to be used for this step's screen (when {@link #screenType} is {@link ScreenType#CHECKLIST}).
checklistTemplateTag String Optional length >= 1 & length <= 255 Points the correct ChecklistInstance (together with {@link #checklistCategoryName}, #checklistTemplateName}) to be used for this step's screen (when {@link #screenType} is {@link ScreenType#CHECKLIST}).
color String Optional length >= 1 & length <= 255 Defines color used to reflect given status in UI.
description String Optional length >= 1
effortType EffortType Required Allowed values { MILEAGE, NONE, TIMEEFFORT, WORKTIME } Defines effort type (e.g. MILEAGE, NONE, TIMEEFFORT, etc).
icon Identifier Optional Icon : 8, 9
name String Optional length >= 1 & length <= 255 Name of the definition.
nextAlternativeStep Identifier Optional ServiceAssignmentStatusDefinition : 9, 10, 11, 12, 13, 14, 15, 16, 17
nextMainStep Identifier Optional ServiceAssignmentStatusDefinition : 9, 10, 11, 12, 13, 14, 15, 16, 17
nextSteps List<Identifier> Optional ServiceAssignmentStatusDefinition : 9, 10, 11, 12, 13, 14, 15, 16, 17 Next steps.
nextStepsInMoreActions List<Identifier> Optional ServiceAssignmentStatusDefinition : 9, 10, 11, 12, 13, 14, 15, 16, 17
ordinal Integer Optional Used for ordering the status definitions for the end user.
personStatusType PersonStatusType Optional Allowed values { AVAILABLE, BUSY, NOT_AVAILABLE, VACATION, UNKNOWN, ON_BREAK, ERRAND } Type od the person status (e.g. AVAILABLE, BUSY, etc)
previewReport Boolean Optional
reportTemplates List<Identifier> Optional ReportTemplate : 10, 11, 12, 13, 14, 15, 16
requiresObjectRating Boolean Optional
requiresSignature Boolean Optional
screenType ScreenType Optional Allowed values { NONE, CHECKLIST, SUMMARY_SCREEN, TRAVEL, WORK_ITEMS } This will define what screen (if any) should be displayed when this workflow step is active.
serviceWorkflow Identifier Optional ServiceWorkflow : 8 Reference to a service workflow.
text String Optional length >= 1 Free text describing the step definition.
timeSubTask Identifier Optional TimeSubTask : 11, 12, 13, 14 Reference to a time subtask linked to the step definition.
timeTask Identifier Optional TimeTask : 13, 14, 15, 16, 17 Reference to a time task linked to the step definition.
workFinished Boolean Required Specifies whether the work is finished or not.
workTimeTask Identifier Optional WorkTimeTask : 11, 12, 13, 14, 15 Reference to a work time task linked to the step definition.