job_template

A job_template contains the information required to instantiate a job from a recurring schedule. It shares almost all of its fields with the job type. During the instantiate process, the values from a job_template are copied into each newly created job.

Name Type Description
code string A free-form string that can be used to categorize the job. This has no effect on optimization.
description string A free-form description of the job. This has no effect on optimization.
disallowed_driver_attributes string[] The job must not be assigned to a route whose driver has any of these attributes. Can be used for forbidden drivers. See Routing with Attributes.
disallowed_route_attributes string[] The job must not be assigned to a route that has any of these attributes. See Routing with Attributes.
exit_location marker or id The location that the driver must travel to immediately after leaving the initial location. See Routing with Linked Stops.
exit_time_on_site timespan The time that the driver will spend at the exit_location. This is ignored if no exit_location is provided.
forbidden_drivers (driver or id)[] The ids of all drivers who are forbidden from performing this job.
job_attributes string[] A list of attributes to assign to the job. These have no effect on optimization.
load float The amount of load delivered at the job. A route can deliver up to its load capacity. Not compatible with loads. See Routing with Capacities.
loads load_amount[] The amount of load delivered at the job per metric. A route can deliver up to its load capacities for the metrics it defines. Metric names must not be duplicated in this list, and up to four unique metric names may be used in a request. Omitted metrics indicate an amount of 0. Not compatible with load. See Routing with Capacities and load_amount.
location marker or id The geographical location of the job site, or the id of a marker defined elsewhere in the request.
notes string Free-form notes relating to the job. These have no effect on optimization.
priority string Either "highest", "high", "normal", "low", or "lowest". If necessary, lower priority jobs are left unrouted first.
required_driver driver or id The id of the driver required to perform this job. Also known as "preferred driver".
required_driver_attributes string[] The job must be assigned to a route whose driver has all of these attributes. See Routing with Attributes.
required_route_attributes string[] The job must be assigned to a route that has all of these attributes. See Routing with Attributes.
required_vehicle_attributes string[] The job must be assigned to a route whose vehicle has all of these attributes. See Routing with Attributes.
required_pre_job_depot_attributes string[] The job on a route must be preceded by depots that have all of these attributes. See Routing with Attributes.
required_post_job_depot_attributes string[] The job on a route must be followed by depots that have all of these attributes. See Routing with Attributes.
time_on_site timespan The time the driver will spend at the job. Defaults to the job type's default_time_on_site.
time_window time_window A window of times that the driver can arrive at the job. Defaults to the job type's default_time_window. See Routing with Time Windows.
time_window2 time_window An alternative window of times that the driver can arrive at the job. See Routing with Time Windows.
type job_type or id The type of job, or the id of a job_type defined elsewhere in the request.

See Also