Overview

This node operation updates an existing route in the Everest Transport Management System (TMS). It allows users to modify various attributes of a route such as its name, color, assigned agent, vehicle details, start and end addresses, routing engine, scheduling options, status, and mission or vehicle assignments. This operation is useful for transport planners and logistics managers who need to adjust route details dynamically to optimize delivery or service schedules.

Use Case Examples

1. Updating the name and color of a route to reflect a new delivery area.
2. Assigning a different agent or vehicle to a route based on availability.
3. Changing the start and end addresses of a route to accommodate new pickup or drop-off points.
4. Re-optimizing a route after updating mission references or vehicle assignments to improve efficiency.

Properties

Output

JSON

• id - The unique identifier of the updated route.
• name - The updated name of the route.
• color - The updated color code of the route.
• agent_id - The ID of the agent assigned to the route.
• agent_vehicle_id - The specific vehicle ID of the agent used for the route.
• address_start - The starting address of the route.
• address_end - The ending address of the route.
• router - The routing engine used for the route.
• split_per_day - Indicates if the route is split per day for multi-day planning.
• early_departure - Indicates if early departure is allowed.
• distribute_fairly - Indicates if tasks are distributed fairly among vehicles.
• status - The status applied to all missions in the route.
• mission_refs - The updated mission references associated with the route.
• vehicles - The updated platform vehicle IDs assigned to the route.
• optimize - Indicates if the route was re-optimized after the update.

Dependencies

• An API key credential for Everest TMS is required to authenticate requests.

Troubleshooting

• Ensure the Route ID provided exists and is correct; otherwise, the update will fail.
• Verify that any referenced agents, vehicles, or mission references exist and are valid in the system.
• Check that the color value is a valid hexadecimal color code if provided.
• If re-optimization is enabled, ensure the routing engine supports the requested optimization parameters.
• Common error messages may include invalid ID errors, permission denied errors due to authentication issues, or validation errors for incorrect field formats.