• Home
  • Guides
  • Reference
  • Support

    Show / Hide Table of Contents
    • API Overview
      • Overview
      • Authentication
      • Retrieving API Results
      • Referenced vs Inline Entities
      • Choosing API Response Data
      • Handling API Errors
    • separator
    • Vehicle Routing Endpoints
      • Path
    • Optimization Endpoints
      • Instantiate
      • Build
      • Assignment Restrictions
      • Optimize
      • Sequence
      • Evaluate
      • Recommend
      • Insert
      • Centroids
      • Zones
      • Consolidate By Job Restrictions
      • Consolidate By Route Assignments
    • Geocoding Endpoints
      • Geocode
      • Reverse Geocode
    • Task Endpoints
      • List
      • Status
      • Result
      • Cancel
    • Sandbox Endpoints
      • List
      • Create
      • Rename
      • Retrieve
      • Update
      • Delete
      • Revisions
      • Add Revision
      • Expiry
      • Permissions
    • Verizon Connect Fleet Integration Endpoints
      • Pull Platform Data
      • Sync Platform Data
      • List Platform Territories
    • Other Endpoints
      • Canonicalize
      • Route Cards
      • Validate
      • Version
    • separator
    • Request Types
      • problem
      • capacity_metric
      • depot
      • driver
      • driver_break
      • job
      • job_template
      • job_type
      • load_amount
      • marker
      • problem_defaults
      • route
      • schedule
      • settings
      • shift
      • shift_override
      • shift_pattern
      • shift_pattern_assignment
      • stop
      • vehicle
      • zone
      • variance
    • Response Types
      • instantiate_response
      • problem_response
      • problem_aggregates
      • driver_response
      • geocoded_location
      • recommend_option
      • route_response
      • schedule_response
      • schedule_instantiate_response
      • stop_response
      • violation
    • Meta Types
      • task_redirect_response
      • task_status_response
      • validate_response
    • Sandbox Types
      • delta
      • array_delta
      • dict_delta
      • keyed_array_delta
      • object_delta
      • set_delta
      • revision
      • revision_created_response
      • revision_response
      • sandbox_response
    • Common Types
      • date_range
      • day_of_week
      • hazmat_load_type
      • id
      • latlon
      • stop_type
      • time_window
      • custom
      • polygon
    • Primitive Types
      • boolean
      • date
      • datetime
      • float
      • integer
      • string
      • timespan

    task_status_response

    task_status_response represents the status of a task.

    Name Type Description
    finished_time datetime The time that the task finished, in UTC, rounded down to the nearest millisecond. Not supplied if the task is still running.
    last_status_time datetime The time that RouteCloud last updated the status of the task, in UTC, rounded down to the nearest millisecond.
    started_time datetime The start time of the task, in UTC, rounded down to the nearest millisecond.
    status string The status of the task. Can be: queued, running, completed, failed, or canceled.
    status_information object Extra information relating to the status of the task. Not included with a tasks list request. The information contained in the object depends on the type of task (see below).
    task_id string The ID of the task.

    status_information

    The status_information field contains additional information relating to the running task. This information is not included if the task has not yet started, or if it has finished.

    For build, sequence, evaluate, recommend, and insert requests, the following information is provided:

    Name Type Description
    aggregates problem_aggregates A summary of the calculated values as they currently stand. Can be used to give an indication of overall progress.
    build_phase integer The number of the build phase RouteCloud is currently performing.
    current_state_percent_complete float The percentage of progress through the current optimizer state, if known.
    num_build_phases integer The total number of build phases RouteCloud needs to perform to complete the task.
    optimizer_state string A description of the current state of the optimization operation. Can be: calculating_times_and_distances, generating_route_options, assigning_jobs_to_routes, optimizing_routes, finishing_build, or calculating_route_paths.

    See Also

    • Retrieving API Results.
    • Tasks: List.
    • Task: Status.