problem
For most RouteCloud api endpoints the request data type is the problem. See the endpoint documentation page to determine which of the following fields are used in that operation.
| Name | Type | Description |
|---|---|---|
| allow_hard_constraint_violations | boolean | See Recommend or Insert |
| capacity_metrics | capacity_metric[] | The capacity metrics that are involved in this problem. See capacity_metric for more. |
| custom | custom | User-supplied custom fields that are returned unmodified in the response. These have no effect on optimization. |
| depots | depot[] | The depots involved in this optimization problem. If defined here, depots can be referenced by id elsewhere; for example, route.depot. |
| drivers | driver[] | The drivers involved in this optimization problem. If defined here, drivers can be referenced by id elsewhere; for example, job.required_driver. |
| id | string | An identifier for the problem. See Request IDs. |
| jobs | job[] | The jobs to assign to routes. |
| jobs_to_insert | job[] | The jobs to assign to insert. See Insert |
| job_types | job_type[] | The job types involved in this problem. If defined here job types can be refereced by id elsewhere; for example job.type |
| markers | marker[] | The markers involved in this optimization problem. If defined here, markers can be referenced by id elsewhere; for example, job.location. |
| max_results | integer | See Recommend |
| max_results_per_route | integer | See Recommend |
| max_results_per_driver | integer | See Recommend |
| max_results_per_date | integer | See Recommend |
| name | string | A name for the problem. See Request IDs. |
| return_request | boolean | See @returning_request |
| routes | route[] | The routes to put jobs on. |
| schedules | schedule[] | Applies recurring schedule constraints to the jobs. |
| settings | settings | The settings to apply during the optimization. |
| shifts | shift[] | The shifts that are involved in this problem. A shift contains all of the information necessary to generate a route using an instantiate call. |
| shift_overrides | shift_override[] | The shift overrides that are involved in this problem. Shift overrides define one-off deviations from the work specified by a shift_pattern. |
| shift_patterns | shift_pattern[] | The shift patterns that are involved in this problem. Shift patterns define the day-by-day ordering of shifts for a driver. |
| vehicles | vehicle[] | The vehicles involved in this optimization problem. If defined here, vehicles can be referenced by id elsewhere; for example, route.vehicle. |
| zones | zone[] | The zones that are involved in this problem. Zones define the geographic boundaries that can be assigned to drivers and in which jobs for a driver can be located. If defined here, zones can be referenced by id elsewhere; for example, driver.zones. |