Root Schema : routingPlanPayload
Type: object
Show Source
{
"type":"object",
"properties":{
"scheduling_plan":{
"description":"Contains a full list of configured routing plans.",
"type":"object",
"properties":{
"label":{
"type":"string",
"description":"Scheduling plan label provided by customer.",
"maxLength":40,
"pattern":"^[A-Za-z0-9_]+$"
},
"name":{
"type":"string",
"description":"Scheduling plan name which is defined by the customer.",
"maxLength":40
},
"description":{
"type":"string",
"description":"Scheduling plan description provided by customer.",
"maxLength":254
},
"active":{
"type":"boolean",
"description":"Actual status of the scheduling plan. Contains 1 for active scheduling plan and 0 for plans that have to be skipped/ignored/prevented depending on launch mode."
},
"type":{
"type":"string",
"description":"Mode how the run of the scheduling plan has to be launched.",
"enum":[
"manual",
"onceaday",
"recurrent",
"continuous",
"immediate",
"sequential"
]
},
"goal_based_optimization":{
"type":"string",
"description":"Optimization goal that is chosen by the customer.",
"enum":[
"balanced",
"minimize_travel",
"maximize_jobs",
"maximize_jobs_density",
"reduce_overdue",
"prio_earlier_start"
]
},
"start_day_offset":{
"type":"integer",
"description":"Start day offset for activity processing regarding the route date. Makes sense for scheduling plans that start automatically."
},
"from_time":{
"type":"string",
"description":"Time when run series has to begin (or single run start time), measured in minutes from midnight in DB; API uses HH:mm format."
},
"to_time":{
"type":"string",
"description":"Time when run series has to end, measured in minutes from midnight in DB; API uses HH:mm format."
},
"interval":{
"type":"integer",
"description":"Time interval between launching recurrent scheduling runs, in minutes.",
"minimum":0,
"maximum":99
},
"weekdays":{
"type":"object",
"description":"Days of the week when the scheduling plan is allowed to run.",
"properties":{
"Sun":{
"type":"boolean",
"description":"Run on Sunday."
},
"Mon":{
"type":"boolean",
"description":"Run on Monday."
},
"Tue":{
"type":"boolean",
"description":"Run on Tuesday."
},
"Wed":{
"type":"boolean",
"description":"Run on Wednesday."
},
"Thu":{
"type":"boolean",
"description":"Run on Thursday."
},
"Fri":{
"type":"boolean",
"description":"Run on Friday."
},
"Sat":{
"type":"boolean",
"description":"Run on Saturday."
}
}
},
"time_limit":{
"type":"integer",
"description":"Time limit for a scheduling run duration, seconds.",
"minimum":0,
"maximum":3600
},
"time_limit_percent_slt":{
"type":"integer",
"description":"Time limit for SLT-service as percents from total scheduling plan time limit.",
"minimum":1,
"maximum":100
},
"auto_ordering":{
"type":"integer",
"description":"Defines the behaviour of not-ordered activities."
},
"uniformity_coeff":{
"type":"number",
"description":"Boolean coefficient to activate the uniform activity assignment 'Try to schedule activities to service window start'.",
"minimum":0,
"maximum":1
},
"home_zone_overstep_wght":{
"type":"integer",
"description":"Weight coefficient for the home zone overstep.",
"minimum":0,
"maximum":999999
},
"resource_overtime":{
"description":"Maximum allowed overtime for all field resources within the scheduling plan. Use a value from -9999 to 9999. The special value 65535 means: do not assign \"overtime\" activities and leave them in the bucket.",
"x-oneOf":[
{
"type":"integer",
"minimum":-9999,
"maximum":9999
},
{
"type":"integer",
"enum":[
65535
]
}
]
},
"unacceptable_travel_time":{
"type":"integer",
"description":"Maximal allowed travel time between neighbouring locations in a route; activity assignment constraint.",
"minimum":0
},
"unacceptable_travel_distance":{
"type":"number",
"description":"Maximal allowed distance between neighbouring locations in a route; activity assignment constraint.",
"minimum":0
},
"travel_optimization_strategy":{
"type":"string",
"description":"Strategy of travel optimization: minimize either travel time or travel distance.",
"enum":[
"shortest",
"fastest"
]
},
"use_slt":{
"type":"boolean",
"description":"Boolean flag that allows using the SLT-service to obtain travel data."
},
"limit_work_by_points":{
"type":"boolean",
"description":"Boolean flag if routes have to be limited by points."
},
"default_home_zone_radius":{
"type":"integer",
"description":"Defines the size of the home zone as the radius regarding the home zone center.",
"minimum":0,
"maximum":99999000
},
"home_zone_enable":{
"type":"boolean",
"description":"Enables home zone restrictions while scheduling."
},
"reopt_enable":{
"type":"integer",
"description":"Enables reoptimization for preassigned activities."
},
"reopt_reduce_overdue_thold":{
"type":"integer",
"description":"Preferable overall reduction of activities overdue value, %, for goal 'Reduce activity overdue'.",
"minimum":0,
"maximum":100
},
"trigger_filter_label":{
"type":"string",
"description":"Trigger filter label used by immediate scheduling. Scheduling starts immediately when an activity matching the selected filter is detected on the bucket."
},
"immediate_scheduling_type":{
"type":"string",
"description":"Immediate scheduling type. Possible values are 'urgent', 'scheduled', 'continuous'.",
"enum":[
"scheduled",
"urgent",
"continuous"
]
},
"assignment_to":{
"type":"integer",
"description":"Number of days for the multiday scheduling.",
"minimum":1,
"maximum":99
},
"bundling_from":{
"type":"integer",
"description":"For immediate plans of scheduled type: start of interval (days) within which activity can be scheduled and bundled."
},
"bundling_to":{
"type":"integer",
"description":"End of interval (days) within which activity can be scheduled and bundled.",
"minimum":0,
"maximum":99
},
"reopt_move_cost_override":{
"type":"integer",
"description":"Allows override of default moving activities penalty.",
"minimum":0,
"maximum":100
},
"reopt_move_cost":{
"type":"number",
"description":"Size of the penalty for moving activities.",
"minimum":0,
"maximum":100
},
"sw_reservation_override":{
"type":"boolean",
"description":"Allows overriding the default value SW_RESERVATION."
},
"sw_reservation":{
"type":"number",
"description":"Reserved part of Service Window from its end where activity assignment is not desired.",
"minimum":0,
"maximum":100
},
"immediate_scheduling_subtype":{
"type":"string",
"description":"Parameter of immediate scheduling for activity assignment: automatic assignment or assignment via collaboration.",
"enum":[
"normal",
"broadcast"
]
},
"collab_routing_time_limit":{
"type":"integer",
"description":"For collaboration assignment: interval for users to accept the activity, minutes.",
"minimum":0,
"maximum":999
},
"message_flow_label":{
"type":"string",
"description":"Message scenario label to run if immediate assignment times out or fails."
},
"scheduling_to_contractor":{
"type":"boolean",
"description":"Defines if assignment to contractor resource is allowed; otherwise activities are moved to bucket."
},
"only_internal_resources":{
"type":"boolean",
"description":"Restricts the use of resources outside the routing bucket."
},
"ignore_work_zone_mismatch":{
"type":"boolean",
"description":"Indicates whether immediate scheduling may ignore work zone mismatch assigning activities."
},
"predecessor_label":{
"type":"string",
"description":"Predecessor scheduling plan label for sequential launch."
},
"inventory_required_days":{
"type":"integer",
"description":"Number of days prior to activity date that inventory is required. 0 means required for all days.",
"minimum":0,
"maximum":99
},
"daily_distance_limit_is_used":{
"type":"boolean",
"description":"Is daily travel distance limitation applied."
},
"unacceptable_daily_distance":{
"type":"number",
"description":"Daily travel distance limitation in Scheduling, km.",
"minimum":0,
"maximum":9999
},
"use_machine_learning":{
"type":"boolean",
"description":"Assign all important activities to field resources, even if it violates constraints"
},
"recomm_min_time_limit":{
"type":"integer",
"description":"Minimal recommended time limit for scheduling plan, seconds.",
"minimum":-1,
"maximum":3600
},
"recomm_max_time_limit":{
"type":"integer",
"description":"Maximal (best) recommended time limit for scheduling plan, seconds.",
"minimum":-1,
"maximum":3600
},
"recomm_balanced_time_limit":{
"type":"integer",
"description":"Balanced recommended time limit for scheduling plan, seconds.",
"minimum":-1,
"maximum":3600
},
"activity_groups":{
"type":"array",
"description":"Defines groups of activities to be distributed during a routing run.",
"items":{
"type":"object",
"properties":{
"filter_label":{
"type":"string",
"description":"Activity filter label used to select activities for the group."
},
"activity_location":{
"type":"string",
"description":"Describes relative location of activities for the group.",
"enum":[
"resource_routing_date",
"resource_non_scheduled",
"bucket_routing_date",
"bucket_non_scheduled",
"bucket_routing_date_and_non_scheduled"
]
},
"unacceptable_overdue":{
"type":"integer",
"description":"Allowed activity overdue, in minutes. Negative values mean the resource must arrive before the end of the time slot. A value of 0 means: assign activities even if the resource is unlikely to arrive inside the time slot. A value of 65535 means: do not assign \"overdue\" activities and leave them in the bucket.",
"minimum":-65534,
"maximum":65535
},
"overdue_cost":{
"type":"number",
"description":"Late arrival penalty per minute of overdue."
},
"non_assignment_cost":{
"type":"number",
"description":"Relative cost of not assigning an activity."
},
"sla_cost_coeff":{
"type":"number",
"description":"Coefficient to modify SLA overdue and non-assignment cost for activities with SLA.",
"minimum":0
},
"sla_overdue_cost":{
"type":"number",
"description":"Relative cost of activity SLA overdue.",
"minimum":-1
},
"sla_violation_fact_cost":{
"type":"number",
"description":"Relative cost of an activity assignment with SLA-violation.",
"minimum":-1
},
"is_multiday":{
"type":"boolean",
"description":"Shows if rescheduling of activities from one day to another within routing plan period is allowed."
},
"autoordering_type":{
"type":"integer",
"description":"Defines the behaviour of not-ordered activities."
},
"sla_policy":{
"type":"integer",
"description":"Defines rules for activities scheduling based on SLA window."
},
"bundling_policy":{
"type":"integer",
"description":"Defines scheduling behaviour for activities with the same visit bundling key."
},
"provider_groups":{
"type":"array",
"description":"Defines groups of resources to be used as destination during a routing run.",
"items":{
"type":"object",
"properties":{
"filter_label":{
"type":"string",
"description":"Resource filter label used to select resources for the provider group."
},
"priority":{
"type":"string",
"description":"Assignment cost that affects the priority of the resource use."
}
}
}
}
}
}
},
"reoptimization_filters":{
"type":"array",
"description":"Defines reoptimization filters for routing plans.",
"items":{
"type":"object",
"properties":{
"filter_label":{
"type":"string",
"description":"Activity filter label used by the reoptimization rule."
},
"destination":{
"type":"string",
"description":"Route destination for activities unassigned by reoptimization.",
"enum":[
"bucket_non_scheduled",
"bucket_routing_date",
"same_resource_non_scheduled",
"same_resource_scheduled",
"prevent_optmization"
]
},
"order":{
"type":"integer",
"description":"Order of application of the reoptimization activity filter."
}
}
}
}
},
"required":[
"label"
]
}
}
}
Nested Schema : scheduling_plan
Type: object
Contains a full list of configured routing plans.
Show Source
-
active:
boolean
Actual status of the scheduling plan. Contains 1 for active scheduling plan and 0 for plans that have to be skipped/ignored/prevented depending on launch mode.
-
activity_groups:
array activity_groups
Defines groups of activities to be distributed during a routing run.
-
assignment_to:
integer
Minimum Value: 1
Maximum Value: 99
Number of days for the multiday scheduling.
-
auto_ordering:
integer
Defines the behaviour of not-ordered activities.
-
bundling_from:
integer
For immediate plans of scheduled type: start of interval (days) within which activity can be scheduled and bundled.
-
bundling_to:
integer
Minimum Value: 0
Maximum Value: 99
End of interval (days) within which activity can be scheduled and bundled.
-
collab_routing_time_limit:
integer
Minimum Value: 0
Maximum Value: 999
For collaboration assignment: interval for users to accept the activity, minutes.
-
daily_distance_limit_is_used:
boolean
Is daily travel distance limitation applied.
-
default_home_zone_radius:
integer
Minimum Value: 0
Maximum Value: 99999000
Defines the size of the home zone as the radius regarding the home zone center.
-
description:
string
Maximum Length: 254
Scheduling plan description provided by customer.
-
from_time:
string
Time when run series has to begin (or single run start time), measured in minutes from midnight in DB; API uses HH:mm format.
-
goal_based_optimization:
string
Allowed Values: [
"balanced",
"minimize_travel",
"maximize_jobs",
"maximize_jobs_density",
"reduce_overdue",
"prio_earlier_start"
]
Optimization goal that is chosen by the customer.
-
home_zone_enable:
boolean
Enables home zone restrictions while scheduling.
-
home_zone_overstep_wght:
integer
Minimum Value: 0
Maximum Value: 999999
Weight coefficient for the home zone overstep.
-
ignore_work_zone_mismatch:
boolean
Indicates whether immediate scheduling may ignore work zone mismatch assigning activities.
-
immediate_scheduling_subtype:
string
-
immediate_scheduling_type:
string
-
interval:
integer
Minimum Value: 0
Maximum Value: 99
Time interval between launching recurrent scheduling runs, in minutes.
-
inventory_required_days:
integer
Minimum Value: 0
Maximum Value: 99
Number of days prior to activity date that inventory is required. 0 means required for all days.
-
label(required):
string
Maximum Length: 40
Pattern: ^[A-Za-z0-9_]+$
Scheduling plan label provided by customer.
-
limit_work_by_points:
boolean
Boolean flag if routes have to be limited by points.
-
message_flow_label:
string
Message scenario label to run if immediate assignment times out or fails.
-
name:
string
Maximum Length: 40
Scheduling plan name which is defined by the customer.
-
only_internal_resources:
boolean
Restricts the use of resources outside the routing bucket.
-
predecessor_label:
string
Predecessor scheduling plan label for sequential launch.
-
recomm_balanced_time_limit:
integer
Minimum Value: -1
Maximum Value: 3600
Balanced recommended time limit for scheduling plan, seconds.
-
recomm_max_time_limit:
integer
Minimum Value: -1
Maximum Value: 3600
Maximal (best) recommended time limit for scheduling plan, seconds.
-
recomm_min_time_limit:
integer
Minimum Value: -1
Maximum Value: 3600
Minimal recommended time limit for scheduling plan, seconds.
-
reopt_enable:
integer
Enables reoptimization for preassigned activities.
-
reopt_move_cost:
number
Minimum Value: 0
Maximum Value: 100
Size of the penalty for moving activities.
-
reopt_move_cost_override:
integer
Minimum Value: 0
Maximum Value: 100
Allows override of default moving activities penalty.
-
reopt_reduce_overdue_thold:
integer
Minimum Value: 0
Maximum Value: 100
Preferable overall reduction of activities overdue value, %, for goal 'Reduce activity overdue'.
-
reoptimization_filters:
array reoptimization_filters
Defines reoptimization filters for routing plans.
-
resource_overtime:
resource_overtime
Maximum allowed overtime for all field resources within the scheduling plan. Use a value from -9999 to 9999. The special value 65535 means: do not assign "overtime" activities and leave them in the bucket.
-
scheduling_to_contractor:
boolean
Defines if assignment to contractor resource is allowed; otherwise activities are moved to bucket.
-
start_day_offset:
integer
Start day offset for activity processing regarding the route date. Makes sense for scheduling plans that start automatically.
-
sw_reservation:
number
Minimum Value: 0
Maximum Value: 100
Reserved part of Service Window from its end where activity assignment is not desired.
-
sw_reservation_override:
boolean
Allows overriding the default value SW_RESERVATION.
-
time_limit:
integer
Minimum Value: 0
Maximum Value: 3600
Time limit for a scheduling run duration, seconds.
-
time_limit_percent_slt:
integer
Minimum Value: 1
Maximum Value: 100
Time limit for SLT-service as percents from total scheduling plan time limit.
-
to_time:
string
Time when run series has to end, measured in minutes from midnight in DB; API uses HH:mm format.
-
travel_optimization_strategy:
string
Allowed Values: [
"shortest",
"fastest"
]
Strategy of travel optimization: minimize either travel time or travel distance.
-
trigger_filter_label:
string
Trigger filter label used by immediate scheduling. Scheduling starts immediately when an activity matching the selected filter is detected on the bucket.
-
type:
string
Allowed Values: [
"manual",
"onceaday",
"recurrent",
"continuous",
"immediate",
"sequential"
]
Mode how the run of the scheduling plan has to be launched.
-
unacceptable_daily_distance:
number
Minimum Value: 0
Maximum Value: 9999
Daily travel distance limitation in Scheduling, km.
-
unacceptable_travel_distance:
number
Minimum Value: 0
Maximal allowed distance between neighbouring locations in a route; activity assignment constraint.
-
unacceptable_travel_time:
integer
Minimum Value: 0
Maximal allowed travel time between neighbouring locations in a route; activity assignment constraint.
-
uniformity_coeff:
number
-
use_machine_learning:
boolean
Assign all important activities to field resources, even if it violates constraints
-
use_slt:
boolean
Boolean flag that allows using the SLT-service to obtain travel data.
-
weekdays:
object weekdays
Days of the week when the scheduling plan is allowed to run.
{
"description":"Contains a full list of configured routing plans.",
"type":"object",
"properties":{
"label":{
"type":"string",
"description":"Scheduling plan label provided by customer.",
"maxLength":40,
"pattern":"^[A-Za-z0-9_]+$"
},
"name":{
"type":"string",
"description":"Scheduling plan name which is defined by the customer.",
"maxLength":40
},
"description":{
"type":"string",
"description":"Scheduling plan description provided by customer.",
"maxLength":254
},
"active":{
"type":"boolean",
"description":"Actual status of the scheduling plan. Contains 1 for active scheduling plan and 0 for plans that have to be skipped/ignored/prevented depending on launch mode."
},
"type":{
"type":"string",
"description":"Mode how the run of the scheduling plan has to be launched.",
"enum":[
"manual",
"onceaday",
"recurrent",
"continuous",
"immediate",
"sequential"
]
},
"goal_based_optimization":{
"type":"string",
"description":"Optimization goal that is chosen by the customer.",
"enum":[
"balanced",
"minimize_travel",
"maximize_jobs",
"maximize_jobs_density",
"reduce_overdue",
"prio_earlier_start"
]
},
"start_day_offset":{
"type":"integer",
"description":"Start day offset for activity processing regarding the route date. Makes sense for scheduling plans that start automatically."
},
"from_time":{
"type":"string",
"description":"Time when run series has to begin (or single run start time), measured in minutes from midnight in DB; API uses HH:mm format."
},
"to_time":{
"type":"string",
"description":"Time when run series has to end, measured in minutes from midnight in DB; API uses HH:mm format."
},
"interval":{
"type":"integer",
"description":"Time interval between launching recurrent scheduling runs, in minutes.",
"minimum":0,
"maximum":99
},
"weekdays":{
"type":"object",
"description":"Days of the week when the scheduling plan is allowed to run.",
"properties":{
"Sun":{
"type":"boolean",
"description":"Run on Sunday."
},
"Mon":{
"type":"boolean",
"description":"Run on Monday."
},
"Tue":{
"type":"boolean",
"description":"Run on Tuesday."
},
"Wed":{
"type":"boolean",
"description":"Run on Wednesday."
},
"Thu":{
"type":"boolean",
"description":"Run on Thursday."
},
"Fri":{
"type":"boolean",
"description":"Run on Friday."
},
"Sat":{
"type":"boolean",
"description":"Run on Saturday."
}
}
},
"time_limit":{
"type":"integer",
"description":"Time limit for a scheduling run duration, seconds.",
"minimum":0,
"maximum":3600
},
"time_limit_percent_slt":{
"type":"integer",
"description":"Time limit for SLT-service as percents from total scheduling plan time limit.",
"minimum":1,
"maximum":100
},
"auto_ordering":{
"type":"integer",
"description":"Defines the behaviour of not-ordered activities."
},
"uniformity_coeff":{
"type":"number",
"description":"Boolean coefficient to activate the uniform activity assignment 'Try to schedule activities to service window start'.",
"minimum":0,
"maximum":1
},
"home_zone_overstep_wght":{
"type":"integer",
"description":"Weight coefficient for the home zone overstep.",
"minimum":0,
"maximum":999999
},
"resource_overtime":{
"description":"Maximum allowed overtime for all field resources within the scheduling plan. Use a value from -9999 to 9999. The special value 65535 means: do not assign \"overtime\" activities and leave them in the bucket.",
"x-oneOf":[
{
"type":"integer",
"minimum":-9999,
"maximum":9999
},
{
"type":"integer",
"enum":[
65535
]
}
]
},
"unacceptable_travel_time":{
"type":"integer",
"description":"Maximal allowed travel time between neighbouring locations in a route; activity assignment constraint.",
"minimum":0
},
"unacceptable_travel_distance":{
"type":"number",
"description":"Maximal allowed distance between neighbouring locations in a route; activity assignment constraint.",
"minimum":0
},
"travel_optimization_strategy":{
"type":"string",
"description":"Strategy of travel optimization: minimize either travel time or travel distance.",
"enum":[
"shortest",
"fastest"
]
},
"use_slt":{
"type":"boolean",
"description":"Boolean flag that allows using the SLT-service to obtain travel data."
},
"limit_work_by_points":{
"type":"boolean",
"description":"Boolean flag if routes have to be limited by points."
},
"default_home_zone_radius":{
"type":"integer",
"description":"Defines the size of the home zone as the radius regarding the home zone center.",
"minimum":0,
"maximum":99999000
},
"home_zone_enable":{
"type":"boolean",
"description":"Enables home zone restrictions while scheduling."
},
"reopt_enable":{
"type":"integer",
"description":"Enables reoptimization for preassigned activities."
},
"reopt_reduce_overdue_thold":{
"type":"integer",
"description":"Preferable overall reduction of activities overdue value, %, for goal 'Reduce activity overdue'.",
"minimum":0,
"maximum":100
},
"trigger_filter_label":{
"type":"string",
"description":"Trigger filter label used by immediate scheduling. Scheduling starts immediately when an activity matching the selected filter is detected on the bucket."
},
"immediate_scheduling_type":{
"type":"string",
"description":"Immediate scheduling type. Possible values are 'urgent', 'scheduled', 'continuous'.",
"enum":[
"scheduled",
"urgent",
"continuous"
]
},
"assignment_to":{
"type":"integer",
"description":"Number of days for the multiday scheduling.",
"minimum":1,
"maximum":99
},
"bundling_from":{
"type":"integer",
"description":"For immediate plans of scheduled type: start of interval (days) within which activity can be scheduled and bundled."
},
"bundling_to":{
"type":"integer",
"description":"End of interval (days) within which activity can be scheduled and bundled.",
"minimum":0,
"maximum":99
},
"reopt_move_cost_override":{
"type":"integer",
"description":"Allows override of default moving activities penalty.",
"minimum":0,
"maximum":100
},
"reopt_move_cost":{
"type":"number",
"description":"Size of the penalty for moving activities.",
"minimum":0,
"maximum":100
},
"sw_reservation_override":{
"type":"boolean",
"description":"Allows overriding the default value SW_RESERVATION."
},
"sw_reservation":{
"type":"number",
"description":"Reserved part of Service Window from its end where activity assignment is not desired.",
"minimum":0,
"maximum":100
},
"immediate_scheduling_subtype":{
"type":"string",
"description":"Parameter of immediate scheduling for activity assignment: automatic assignment or assignment via collaboration.",
"enum":[
"normal",
"broadcast"
]
},
"collab_routing_time_limit":{
"type":"integer",
"description":"For collaboration assignment: interval for users to accept the activity, minutes.",
"minimum":0,
"maximum":999
},
"message_flow_label":{
"type":"string",
"description":"Message scenario label to run if immediate assignment times out or fails."
},
"scheduling_to_contractor":{
"type":"boolean",
"description":"Defines if assignment to contractor resource is allowed; otherwise activities are moved to bucket."
},
"only_internal_resources":{
"type":"boolean",
"description":"Restricts the use of resources outside the routing bucket."
},
"ignore_work_zone_mismatch":{
"type":"boolean",
"description":"Indicates whether immediate scheduling may ignore work zone mismatch assigning activities."
},
"predecessor_label":{
"type":"string",
"description":"Predecessor scheduling plan label for sequential launch."
},
"inventory_required_days":{
"type":"integer",
"description":"Number of days prior to activity date that inventory is required. 0 means required for all days.",
"minimum":0,
"maximum":99
},
"daily_distance_limit_is_used":{
"type":"boolean",
"description":"Is daily travel distance limitation applied."
},
"unacceptable_daily_distance":{
"type":"number",
"description":"Daily travel distance limitation in Scheduling, km.",
"minimum":0,
"maximum":9999
},
"use_machine_learning":{
"type":"boolean",
"description":"Assign all important activities to field resources, even if it violates constraints"
},
"recomm_min_time_limit":{
"type":"integer",
"description":"Minimal recommended time limit for scheduling plan, seconds.",
"minimum":-1,
"maximum":3600
},
"recomm_max_time_limit":{
"type":"integer",
"description":"Maximal (best) recommended time limit for scheduling plan, seconds.",
"minimum":-1,
"maximum":3600
},
"recomm_balanced_time_limit":{
"type":"integer",
"description":"Balanced recommended time limit for scheduling plan, seconds.",
"minimum":-1,
"maximum":3600
},
"activity_groups":{
"type":"array",
"description":"Defines groups of activities to be distributed during a routing run.",
"items":{
"type":"object",
"properties":{
"filter_label":{
"type":"string",
"description":"Activity filter label used to select activities for the group."
},
"activity_location":{
"type":"string",
"description":"Describes relative location of activities for the group.",
"enum":[
"resource_routing_date",
"resource_non_scheduled",
"bucket_routing_date",
"bucket_non_scheduled",
"bucket_routing_date_and_non_scheduled"
]
},
"unacceptable_overdue":{
"type":"integer",
"description":"Allowed activity overdue, in minutes. Negative values mean the resource must arrive before the end of the time slot. A value of 0 means: assign activities even if the resource is unlikely to arrive inside the time slot. A value of 65535 means: do not assign \"overdue\" activities and leave them in the bucket.",
"minimum":-65534,
"maximum":65535
},
"overdue_cost":{
"type":"number",
"description":"Late arrival penalty per minute of overdue."
},
"non_assignment_cost":{
"type":"number",
"description":"Relative cost of not assigning an activity."
},
"sla_cost_coeff":{
"type":"number",
"description":"Coefficient to modify SLA overdue and non-assignment cost for activities with SLA.",
"minimum":0
},
"sla_overdue_cost":{
"type":"number",
"description":"Relative cost of activity SLA overdue.",
"minimum":-1
},
"sla_violation_fact_cost":{
"type":"number",
"description":"Relative cost of an activity assignment with SLA-violation.",
"minimum":-1
},
"is_multiday":{
"type":"boolean",
"description":"Shows if rescheduling of activities from one day to another within routing plan period is allowed."
},
"autoordering_type":{
"type":"integer",
"description":"Defines the behaviour of not-ordered activities."
},
"sla_policy":{
"type":"integer",
"description":"Defines rules for activities scheduling based on SLA window."
},
"bundling_policy":{
"type":"integer",
"description":"Defines scheduling behaviour for activities with the same visit bundling key."
},
"provider_groups":{
"type":"array",
"description":"Defines groups of resources to be used as destination during a routing run.",
"items":{
"type":"object",
"properties":{
"filter_label":{
"type":"string",
"description":"Resource filter label used to select resources for the provider group."
},
"priority":{
"type":"string",
"description":"Assignment cost that affects the priority of the resource use."
}
}
}
}
}
}
},
"reoptimization_filters":{
"type":"array",
"description":"Defines reoptimization filters for routing plans.",
"items":{
"type":"object",
"properties":{
"filter_label":{
"type":"string",
"description":"Activity filter label used by the reoptimization rule."
},
"destination":{
"type":"string",
"description":"Route destination for activities unassigned by reoptimization.",
"enum":[
"bucket_non_scheduled",
"bucket_routing_date",
"same_resource_non_scheduled",
"same_resource_scheduled",
"prevent_optmization"
]
},
"order":{
"type":"integer",
"description":"Order of application of the reoptimization activity filter."
}
}
}
}
},
"required":[
"label"
]
}
Nested Schema : activity_groups
Type: array
Defines groups of activities to be distributed during a routing run.
Show Source
{
"type":"array",
"description":"Defines groups of activities to be distributed during a routing run.",
"items":{
"type":"object",
"properties":{
"filter_label":{
"type":"string",
"description":"Activity filter label used to select activities for the group."
},
"activity_location":{
"type":"string",
"description":"Describes relative location of activities for the group.",
"enum":[
"resource_routing_date",
"resource_non_scheduled",
"bucket_routing_date",
"bucket_non_scheduled",
"bucket_routing_date_and_non_scheduled"
]
},
"unacceptable_overdue":{
"type":"integer",
"description":"Allowed activity overdue, in minutes. Negative values mean the resource must arrive before the end of the time slot. A value of 0 means: assign activities even if the resource is unlikely to arrive inside the time slot. A value of 65535 means: do not assign \"overdue\" activities and leave them in the bucket.",
"minimum":-65534,
"maximum":65535
},
"overdue_cost":{
"type":"number",
"description":"Late arrival penalty per minute of overdue."
},
"non_assignment_cost":{
"type":"number",
"description":"Relative cost of not assigning an activity."
},
"sla_cost_coeff":{
"type":"number",
"description":"Coefficient to modify SLA overdue and non-assignment cost for activities with SLA.",
"minimum":0
},
"sla_overdue_cost":{
"type":"number",
"description":"Relative cost of activity SLA overdue.",
"minimum":-1
},
"sla_violation_fact_cost":{
"type":"number",
"description":"Relative cost of an activity assignment with SLA-violation.",
"minimum":-1
},
"is_multiday":{
"type":"boolean",
"description":"Shows if rescheduling of activities from one day to another within routing plan period is allowed."
},
"autoordering_type":{
"type":"integer",
"description":"Defines the behaviour of not-ordered activities."
},
"sla_policy":{
"type":"integer",
"description":"Defines rules for activities scheduling based on SLA window."
},
"bundling_policy":{
"type":"integer",
"description":"Defines scheduling behaviour for activities with the same visit bundling key."
},
"provider_groups":{
"type":"array",
"description":"Defines groups of resources to be used as destination during a routing run.",
"items":{
"type":"object",
"properties":{
"filter_label":{
"type":"string",
"description":"Resource filter label used to select resources for the provider group."
},
"priority":{
"type":"string",
"description":"Assignment cost that affects the priority of the resource use."
}
}
}
}
}
}
}
Nested Schema : reoptimization_filters
Type: array
Defines reoptimization filters for routing plans.
Show Source
{
"type":"array",
"description":"Defines reoptimization filters for routing plans.",
"items":{
"type":"object",
"properties":{
"filter_label":{
"type":"string",
"description":"Activity filter label used by the reoptimization rule."
},
"destination":{
"type":"string",
"description":"Route destination for activities unassigned by reoptimization.",
"enum":[
"bucket_non_scheduled",
"bucket_routing_date",
"same_resource_non_scheduled",
"same_resource_scheduled",
"prevent_optmization"
]
},
"order":{
"type":"integer",
"description":"Order of application of the reoptimization activity filter."
}
}
}
}
Nested Schema : resource_overtime
Maximum allowed overtime for all field resources within the scheduling plan. Use a value from -9999 to 9999. The special value 65535 means: do not assign "overtime" activities and leave them in the bucket.
Match One
Show Source
-
integer
Minimum Value: -9999
Maximum Value: 9999
-
integer
Allowed Values: [
65535
]
{
"description":"Maximum allowed overtime for all field resources within the scheduling plan. Use a value from -9999 to 9999. The special value 65535 means: do not assign \"overtime\" activities and leave them in the bucket.",
"x-oneOf":[
{
"type":"integer",
"minimum":-9999,
"maximum":9999
},
{
"type":"integer",
"enum":[
65535
]
}
]
}
Nested Schema : weekdays
Type: object
Days of the week when the scheduling plan is allowed to run.
Show Source
{
"type":"object",
"description":"Days of the week when the scheduling plan is allowed to run.",
"properties":{
"Sun":{
"type":"boolean",
"description":"Run on Sunday."
},
"Mon":{
"type":"boolean",
"description":"Run on Monday."
},
"Tue":{
"type":"boolean",
"description":"Run on Tuesday."
},
"Wed":{
"type":"boolean",
"description":"Run on Wednesday."
},
"Thu":{
"type":"boolean",
"description":"Run on Thursday."
},
"Fri":{
"type":"boolean",
"description":"Run on Friday."
},
"Sat":{
"type":"boolean",
"description":"Run on Saturday."
}
}
}
Nested Schema : items
Type: object
Show Source
-
activity_location:
string
Allowed Values: [
"resource_routing_date",
"resource_non_scheduled",
"bucket_routing_date",
"bucket_non_scheduled",
"bucket_routing_date_and_non_scheduled"
]
Describes relative location of activities for the group.
-
autoordering_type:
integer
Defines the behaviour of not-ordered activities.
-
bundling_policy:
integer
Defines scheduling behaviour for activities with the same visit bundling key.
-
filter_label:
string
Activity filter label used to select activities for the group.
-
is_multiday:
boolean
Shows if rescheduling of activities from one day to another within routing plan period is allowed.
-
non_assignment_cost:
number
Relative cost of not assigning an activity.
-
overdue_cost:
number
Late arrival penalty per minute of overdue.
-
provider_groups:
array provider_groups
Defines groups of resources to be used as destination during a routing run.
-
sla_cost_coeff:
number
Minimum Value: 0
Coefficient to modify SLA overdue and non-assignment cost for activities with SLA.
-
sla_overdue_cost:
number
Minimum Value: -1
Relative cost of activity SLA overdue.
-
sla_policy:
integer
Defines rules for activities scheduling based on SLA window.
-
sla_violation_fact_cost:
number
Minimum Value: -1
Relative cost of an activity assignment with SLA-violation.
-
unacceptable_overdue:
integer
Minimum Value: -65534
Maximum Value: 65535
Allowed activity overdue, in minutes. Negative values mean the resource must arrive before the end of the time slot. A value of 0 means: assign activities even if the resource is unlikely to arrive inside the time slot. A value of 65535 means: do not assign "overdue" activities and leave them in the bucket.
{
"type":"object",
"properties":{
"filter_label":{
"type":"string",
"description":"Activity filter label used to select activities for the group."
},
"activity_location":{
"type":"string",
"description":"Describes relative location of activities for the group.",
"enum":[
"resource_routing_date",
"resource_non_scheduled",
"bucket_routing_date",
"bucket_non_scheduled",
"bucket_routing_date_and_non_scheduled"
]
},
"unacceptable_overdue":{
"type":"integer",
"description":"Allowed activity overdue, in minutes. Negative values mean the resource must arrive before the end of the time slot. A value of 0 means: assign activities even if the resource is unlikely to arrive inside the time slot. A value of 65535 means: do not assign \"overdue\" activities and leave them in the bucket.",
"minimum":-65534,
"maximum":65535
},
"overdue_cost":{
"type":"number",
"description":"Late arrival penalty per minute of overdue."
},
"non_assignment_cost":{
"type":"number",
"description":"Relative cost of not assigning an activity."
},
"sla_cost_coeff":{
"type":"number",
"description":"Coefficient to modify SLA overdue and non-assignment cost for activities with SLA.",
"minimum":0
},
"sla_overdue_cost":{
"type":"number",
"description":"Relative cost of activity SLA overdue.",
"minimum":-1
},
"sla_violation_fact_cost":{
"type":"number",
"description":"Relative cost of an activity assignment with SLA-violation.",
"minimum":-1
},
"is_multiday":{
"type":"boolean",
"description":"Shows if rescheduling of activities from one day to another within routing plan period is allowed."
},
"autoordering_type":{
"type":"integer",
"description":"Defines the behaviour of not-ordered activities."
},
"sla_policy":{
"type":"integer",
"description":"Defines rules for activities scheduling based on SLA window."
},
"bundling_policy":{
"type":"integer",
"description":"Defines scheduling behaviour for activities with the same visit bundling key."
},
"provider_groups":{
"type":"array",
"description":"Defines groups of resources to be used as destination during a routing run.",
"items":{
"type":"object",
"properties":{
"filter_label":{
"type":"string",
"description":"Resource filter label used to select resources for the provider group."
},
"priority":{
"type":"string",
"description":"Assignment cost that affects the priority of the resource use."
}
}
}
}
}
}
Nested Schema : provider_groups
Type: array
Defines groups of resources to be used as destination during a routing run.
Show Source
{
"type":"array",
"description":"Defines groups of resources to be used as destination during a routing run.",
"items":{
"type":"object",
"properties":{
"filter_label":{
"type":"string",
"description":"Resource filter label used to select resources for the provider group."
},
"priority":{
"type":"string",
"description":"Assignment cost that affects the priority of the resource use."
}
}
}
}
Nested Schema : items
Type: object
Show Source
{
"type":"object",
"properties":{
"filter_label":{
"type":"string",
"description":"Resource filter label used to select resources for the provider group."
},
"priority":{
"type":"string",
"description":"Assignment cost that affects the priority of the resource use."
}
}
}
Nested Schema : items
Type: object
Show Source
-
destination:
string
Allowed Values: [
"bucket_non_scheduled",
"bucket_routing_date",
"same_resource_non_scheduled",
"same_resource_scheduled",
"prevent_optmization"
]
Route destination for activities unassigned by reoptimization.
-
filter_label:
string
Activity filter label used by the reoptimization rule.
-
order:
integer
Order of application of the reoptimization activity filter.
{
"type":"object",
"properties":{
"filter_label":{
"type":"string",
"description":"Activity filter label used by the reoptimization rule."
},
"destination":{
"type":"string",
"description":"Route destination for activities unassigned by reoptimization.",
"enum":[
"bucket_non_scheduled",
"bucket_routing_date",
"same_resource_non_scheduled",
"same_resource_scheduled",
"prevent_optmization"
]
},
"order":{
"type":"integer",
"description":"Order of application of the reoptimization activity filter."
}
}
}