Download OpenAPI specification:
| taskId required | string |
{- "statuses": [
- {
- "status": "InQueue",
- "date": "2019-08-24T14:15:22Z"
}
], - "timeNumOffset": "string",
- "executingDuration": 0,
- "tasksInQueue": 0,
- "planningVariants": [
- {
- "planningVariantId": "string",
- "status": "string",
- "proposals": [
- {
- "sequentialNumber": 0,
- "itineraries": [
- {
- "itinerary": {
- "stops": [
- {
- "sequentialNumber": null,
- "stopId": null,
- "locationId": null,
- "pointsGroupId": null,
- "runNumber": null,
- "scheduleArrivalDate": null,
- "scheduleDepartureDate": null,
- "geopoint": null,
- "arrivalDate": null,
- "startJobsDate": null,
- "endJobsDate": null,
- "departureDate": null,
- "distance": null,
- "duration": null,
- "track": null,
- "simplifiedTrack": null,
- "options": null,
- "timeWindow": null,
- "jobs": [ ],
- "timeWindowViolation": null
}
], - "predecessors": [
- {
- "stopId": null,
- "predecessorId": null
}
], - "itineraryId": "string",
- "vehicleId": "string",
- "scheduleId": "string",
- "vehicleAccessibilityTimeWindow": {
- "form": "absolute",
- "justInTime": true,
- "dateStart": "string",
- "timeStart": "string",
- "dateEnd": "string",
- "timeEnd": "string",
- "offset": 0
}
}, - "statistics": {
- "timeStatistics": {
- "duration": 0,
- "emptyMovesDuration": 0,
- "averageLegDuration": 0,
- "outYardPreparationDuration": 0,
- "inYardPreparationDuration": 0,
- "dwellTime": 0,
- "waitingTime": 0,
- "inYardDepartureDuration": 0,
- "outYardDepartureDuration": 0,
- "timeWindowsViolation": true
}, - "distanceStatistics": {
- "distance": 0,
- "emptyMovesDistance": 0,
- "averageLegDistance": 0
}, - "aggregatePlanStatistics": {
- "itinerariesNumber": 0,
- "replannedItinerariesNumber": 0,
- "runsNumber": 0,
- "stopsNumber": 0,
- "movementsNumber": 0,
- "legsNumber": 0,
- "emptyLegsNumber": 0,
- "satisfiedDemand": [
- null
]
}, - "resourceUtilizationStatistics": {
- "utilizedVehiclesNumber": 0,
- "utilizedCompartmentsNumber": 0,
- "utilizedExtraCompartmentsNumber": 0,
- "notUtilizedVehiclesNumber": 0,
- "notUtilizedCompartmentsNumber": 0,
- "notUtilizedExtraCompartmentsNumber": 0,
- "capacityUtilizationRate": 0,
- "maxUtilizedCapacity": [
- null
]
}, - "costsStatistics": {
- "costs": 0.1,
- "penalties": 0.1,
- "activationCosts": 0.1,
- "movementCosts": 0.1,
- "runCosts": 0.1,
- "stopCosts": 0.1,
- "distanceCosts": 0.1,
- "departureMovementsDistanceCosts": 0.1,
- "arrivalMovementsDistanceCosts": 0.1,
- "durationCosts": 0.1,
- "waitingCosts": 0.1,
- "departureMovementsDurationCosts": 0.1,
- "arrivalMovementsDurationCosts": 0.1,
- "nonScheduleUsageMovementCosts": 0.1,
- "softWindowsPenalty": {
- "penalty": null,
- "out_of_time_minute": null,
- "out_of_time_fixed": null,
- "early_fixed": null,
- "early_minute": null,
- "late_fixed": null,
- "late_minute": null
}
}
}
}
], - "unplannedMovements": [
- "string"
], - "infeasibleMovements": [
- "string"
], - "statistics": {
- "timeStatistics": {
- "duration": 0,
- "emptyMovesDuration": 0,
- "averageLegDuration": 0,
- "outYardPreparationDuration": 0,
- "inYardPreparationDuration": 0,
- "dwellTime": 0,
- "waitingTime": 0,
- "inYardDepartureDuration": 0,
- "outYardDepartureDuration": 0,
- "timeWindowsViolation": true
}, - "distanceStatistics": {
- "distance": 0,
- "emptyMovesDistance": 0,
- "averageLegDistance": 0
}, - "aggregatePlanStatistics": {
- "itinerariesNumber": 0,
- "replannedItinerariesNumber": 0,
- "runsNumber": 0,
- "stopsNumber": 0,
- "movementsNumber": 0,
- "legsNumber": 0,
- "emptyLegsNumber": 0,
- "satisfiedDemand": [
- {
- "propertyId": "string",
- "value": 0.1
}
]
}, - "resourceUtilizationStatistics": {
- "utilizedVehiclesNumber": 0,
- "utilizedCompartmentsNumber": 0,
- "utilizedExtraCompartmentsNumber": 0,
- "notUtilizedVehiclesNumber": 0,
- "notUtilizedCompartmentsNumber": 0,
- "notUtilizedExtraCompartmentsNumber": 0,
- "capacityUtilizationRate": 0,
- "maxUtilizedCapacity": [
- {
- "propertyId": "string",
- "value": 0.1
}
]
}, - "costsStatistics": {
- "costs": 0.1,
- "penalties": 0.1,
- "activationCosts": 0.1,
- "movementCosts": 0.1,
- "runCosts": 0.1,
- "stopCosts": 0.1,
- "distanceCosts": 0.1,
- "departureMovementsDistanceCosts": 0.1,
- "arrivalMovementsDistanceCosts": 0.1,
- "durationCosts": 0.1,
- "waitingCosts": 0.1,
- "departureMovementsDurationCosts": 0.1,
- "arrivalMovementsDurationCosts": 0.1,
- "nonScheduleUsageMovementCosts": 0.1,
- "softWindowsPenalty": {
- "penalty": 0.1,
- "out_of_time_minute": 0.1,
- "out_of_time_fixed": 0.1,
- "early_fixed": 0.1,
- "early_minute": 0.1,
- "late_fixed": 0.1,
- "late_minute": 0.1
}
}
}, - "metrics": {
- "cost": 0.1,
- "routeCosts": 0.1,
- "routePenalties": 0.1,
- "distance_m": 0,
- "duration_sek": 0,
- "itinerariesNumber": 0,
- "total_global_proximity_distance_m": 0.1,
- "total_proximity_distance_m": 0.1,
- "route_proximity_distance_units": 0.1,
- "longDistanceFromLastPoint": 0.1,
- "longDistanceDelivery": 0.1,
- "runClusterDistance": 0.1,
- "firstSolutionCost": 0.1,
- "firstSolutionTime": 0.1,
- "solutionTime": 0.1,
- "improvementRate": 0.1,
- "runsCount": 0,
- "totalWaiting": 0.1,
- "unplannedMovementsCount": 0,
- "unplannedOrdersCount": 0,
- "unplannedMovementsCountIn1stSol": 0,
- "unplannedOrdersCountIn1stSol": 0,
- "infeasibleMovementsCount": 0,
- "infeasibleOrdersCount": 0,
- "penalties": 0.1
}, - "charts": [
- {
- "chartId": "string",
- "name": "string",
- "title": "string",
- "data": [
- {
- "type": "line",
- "name": "string",
- "x": [
- null
], - "y": [
- null
], - "values": [
- null
], - "labels": [
- null
]
}
], - "layout": {
- "orientation": "vertical",
- "xAxis": {
- "variable": "string",
- "uom": "string"
}, - "yAxis": {
- "variable": "string",
- "uom": "string"
}
}, - "remark": "string"
}
]
}
]
}
], - "measuredProperties": [
- {
- "propertyId": "string",
- "name": "string",
- "uom": "string"
}
], - "complexityEstimated": {
- "uniquePoints": 0,
- "startTimes": 0,
- "dimensions": 0,
- "complexity": 0
}, - "error": {
- "message": "string"
}
}| taskId required | string |
| variantId | string |
{- "type": "string",
- "features": [
- {
- "type": "string",
- "properties": {
- "stroke": "string",
- "marker-color": "string",
- "vehicleId": "string",
- "jobs": "string",
- "stroke-width": 0,
- "number": 0
}, - "geometry": {
- "type": "string"
}
}
]
}| loadToFile | boolean Выгрузить в файлы кэш расстояний и информацию для отладки |
required | object (RouteCalcVrpOptions) Опции решения задачи RVRP. |
required | object (RouteCalcVrpPlanningData) Данные задачи. |
required | Array of objects (RouteCalcVrpPlanningVariants) Список вариантов планирования для данных. |
{- "loadToFile": true,
- "options": {
- "bestResultStrategyDetermination": "minCost",
- "runtimeSettings": {
- "maxThreads": 1,
- "maxRuntime": 0,
- "maxTimeWithoutImprovement": 300,
- "taskCacheTimeout": 0,
- "disableImprovementStage": false,
- "loggingMode": "Disabled",
- "diagnosticsMode": {
- "value": "simple",
- "hint": "string"
}
}, - "planningHorizon": {
- "dateStart": "2019-08-24T14:15:22Z",
- "dateEnd": "2019-08-24T14:15:22Z"
}, - "timeNumOffset": "string",
- "routingOptions": {
- "routingSource": "geodesicDistances",
- "averageSpeed": 60,
- "enableRouting": true,
- "obligatoryCalculation": false,
- "routerId": "string",
- "router": {
- "name": "string",
- "id": "string",
- "url": "string",
- "port": 0,
- "apiKey": "string",
- "enableRequestLogs": true,
- "enableResponseLogs": true,
- "routeDurationValidity": 0,
- "externalKey": "string"
}, - "trackRequired": false,
- "simplifiedTrackRequired": false,
- "dimension": "string",
- "distanceMatrixCalculationMode": "dynamic",
- "trafficDataUsageMode": "Prohibited",
- "maxThreads": 1
}, - "errorHandlingSettings": {
- "routingErrorsLimit": 0,
- "disableMovementsFeasibilityControl": true
}, - "measuredProperties": [
- {
- "propertyId": "string",
- "name": "string",
- "uom": "string"
}
]
}, - "planningData": {
- "orders": [
- {
- "orderId": "string",
- "name": "string"
}
], - "movements": [
- {
- "movementId": "string",
- "name": "string",
- "orderId": "string",
- "pointsStart": [
- {
- "movementPointId": "string",
- "locationId": "string",
- "stopId": "string",
- "softTimeWindowPenalty": {
- "penalty_out_of_time_minute": 0.1,
- "penalty_out_of_time_fixed": 0.1,
- "penalty_early_fixed": 0.1,
- "penalty_early_minute": 0.1,
- "penalty_late_fixed": 0.1,
- "penalty_late_minute": 0.1
}, - "softTimeWindowOption": {
- "max_early_arrive_sek": 0.1,
- "max_late_departure_sek": 0.1
}, - "geopoint": {
- "latitude": 0.1,
- "longitude": 0.1
}, - "timeWindowsform": "absolute",
- "timeWindows": [
- {
- "form": "absolute",
- "justInTime": true,
- "dateStart": "string",
- "timeStart": "string",
- "dateEnd": "string",
- "timeEnd": "string",
- "offset": 0
}
], - "serviceDuration": 0,
- "pointsGroupId": "string",
- "geozones": [
- "string"
]
}
], - "pointsEnd": [
- {
- "movementPointId": "string",
- "locationId": "string",
- "stopId": "string",
- "softTimeWindowPenalty": {
- "penalty_out_of_time_minute": 0.1,
- "penalty_out_of_time_fixed": 0.1,
- "penalty_early_fixed": 0.1,
- "penalty_early_minute": 0.1,
- "penalty_late_fixed": 0.1,
- "penalty_late_minute": 0.1
}, - "softTimeWindowOption": {
- "max_early_arrive_sek": 0.1,
- "max_late_departure_sek": 0.1
}, - "geopoint": {
- "latitude": 0.1,
- "longitude": 0.1
}, - "timeWindowsform": "absolute",
- "timeWindows": [
- {
- "form": "absolute",
- "justInTime": true,
- "dateStart": "string",
- "timeStart": "string",
- "dateEnd": "string",
- "timeEnd": "string",
- "offset": 0
}
], - "serviceDuration": 0,
- "pointsGroupId": "string",
- "geozones": [
- "string"
]
}
], - "demand": [
- {
- "propertyId": "string",
- "value": 0.1
}
]
}
], - "plannedMovements": [
- {
- "itineraryId": "string",
- "vehicleId": "string",
- "scheduleId": "string",
- "allowVehicleChange": true,
- "movements": [
- "string"
]
}
], - "pointsGroups": [
- {
- "pointsGroupId": "string",
- "name": "string",
- "options": {
- "outYardPreparationDuration": 0,
- "inYardPreparationDuration": 0,
- "enableFixedServiceDuration": true,
- "serviceDuration": 0,
- "inYardDepartureDuration": 0,
- "outYardDepartureDuration": 0,
- "warehouse": true
}
}
], - "predecessors": [
- {
- "movementId": "string",
- "predecessorId": "string"
}
], - "vehiclesDislocationSettings": [
- {
- "dislocationSettingsId": "string",
- "locationIdStart": "string",
- "stopIdStart": "string",
- "geopointStart": {
- "latitude": 0.1,
- "longitude": 0.1
}, - "locationIdEnd": "string",
- "stopIdEnd": "string",
- "geopointEnd": {
- "latitude": 0.1,
- "longitude": 0.1
}
}
], - "carriers": [
- {
- "carrierId": "string",
- "name": "string"
}
], - "vehiclesTypes": [
- {
- "vehicleTypeId": "string",
- "capacity": [
- {
- "propertyId": "string",
- "value": 0.1
}
], - "vehicleWithCompartments": true,
- "flexibleCompartmentsCapacity": true,
- "compartments": [
- {
- "compartmentId": "string",
- "name": "string",
- "capacity": [
- {
- "propertyId": "string",
- "value": 0.1
}
]
}
]
}
], - "vehicleResources": [
- {
- "vehicle": {
- "vehicleId": "string",
- "name": "string",
- "vehicleTypeId": "string",
- "dislocationSettingsId": "string",
- "carrierId": "string",
- "avoidZones": [
- "string"
], - "avoidTollRoads": true,
- "avoidFerries": true,
- "avoidRoughRoads": true,
- "accessibilitySettingsId": "string"
}, - "quantity": 0
}
], - "vehicleAccessibilitySettings": [
- {
- "accessibilitySettingsId": "string",
- "schedule": {
- "dateStart": "2019-08-24T14:15:22Z",
- "dateEnd": "2019-08-24T14:15:22Z"
}
}
], - "geozones": [
- {
- "parentId": "string",
- "geozoneId": "string"
}
], - "schedules": [
- {
- "scheduleId": "string",
- "vehicleId": "string",
- "scheduleLines": [
- {
- "sequentialNumber": "string",
- "locationId": "string",
- "pointsGroupId": "string",
- "geopoint": {
- "latitude": 0.1,
- "longitude": 0.1
}, - "expectedArrivalDate": "string",
- "expectedDepartureDate": "string",
- "stopId": "string"
}, - {
- "sequentialNumber": "string",
- "locationId": "string",
- "pointsGroupId": "string",
- "geopoint": {
- "latitude": 0.1,
- "longitude": 0.1
}, - "expectedArrivalDate": "string",
- "expectedDepartureDate": "string",
- "stopId": "string"
}
]
}
]
}, - "planningVariants": [
- {
- "planningVariantId": "string",
- "quality": {
- "value": "Auto",
- "hint": "string",
- "maxProposalsNumber": 5
}, - "timeWindowSettings": {
- "enableSoftTimeWindow": true,
- "defaultSoftTimeWindowPenalty": {
- "penalty_out_of_time_minute": 0.1,
- "penalty_out_of_time_fixed": 0.1,
- "penalty_early_fixed": 0.1,
- "penalty_early_minute": 0.1,
- "penalty_late_fixed": 0.1,
- "penalty_late_minute": 0.1
}, - "defaultSoftTimeWindowOption": {
- "max_early_arrive_sek": 0.1,
- "max_late_departure_sek": 0.1
}
}, - "itineraryBuildingSettings": {
- "runDeterminationStrategy": "oneRunForItinerary",
- "oneWarehouseForRun": true,
- "oneWarehouseVisitForRun": true
}, - "ordersSettings": [
- {
- "orderSettingsId": "string",
- "movementsGroupingForVisitRequired": true,
- "movementsGroupingForRunRequired": true,
- "movementsGroupingForItineraryRequired": true,
- "allMovementsPlanningRequired": true,
- "nondeliveryCost": 0.1
}
], - "ordersSettingsAssignments": [
- {
- "orderSettingsId": "string",
- "orders": [
- "string"
]
}
], - "movementsSettings": [
- {
- "movementSettingsId": "string",
- "nondeliveryCost": 0.1,
- "scheduleUsageRequired": true,
- "nonScheduleUsageCost": 0.1
}
], - "movementsSettingsAssignments": [
- {
- "movementSettingsId": "string",
- "movements": [
- "string"
]
}
], - "vehiclesSettings": [
- {
- "vehicleSettingsId": "string",
- "activationCost": 0.1,
- "movementCost": 0.1,
- "runCost": 0.1,
- "stopCost": 0.1,
- "maxRuns": 0,
- "maxStopsForRun": 0,
- "distanceCost": 0.1,
- "enableDepartureMovementsInCost": true,
- "maxDistanceForRun": 0,
- "durationCost": 0.1,
- "waitingCost": 0.1,
- "enableArrivalMovementsInCost": true,
- "maxRunDuration": 0,
- "yardSettings": {
- "itineraryStartingStrategy": "includeOutYardPreparationDuration",
- "itineraryEndingStrategy": "excludeInYardDepartureDuration"
}, - "maxMovementsForRun": 0,
- "shippingSettings": {
- "movementTypeConstraints": "onlyPickups",
- "loadDeterminationStrategy": "backhauling"
}, - "maximumAverageSpeed": 1,
- "routerDataFactor": 0.01
}
], - "vehiclesSettingsAssignments": [
- {
- "vehiclesSettingsId": "string",
- "vehicles": [
- "string"
]
}
], - "compatibilities": [
- {
- "compatibilitySettingsId": "string",
- "controlType": "movementPointsWithVehicles",
- "firstCondition": "string",
- "secondCondition": "string"
}
], - "incompatibilities": [
- {
- "compatibilitySettingsId": "string",
- "controlType": "movementPointsWithVehicles",
- "firstCondition": "string",
- "secondCondition": "string"
}
], - "compatibilityConditionsAssignments": {
- "movementsConditions": [
- {
- "entityId": "string",
- "compatibilityConditions": [
- "string"
], - "incompatibilityConditions": [
- "string"
]
}
], - "movementPointsConditions": [
- {
- "entityId": "string",
- "compatibilityConditions": [
- "string"
], - "incompatibilityConditions": [
- "string"
]
}
], - "vehiclesConditions": [
- {
- "entityId": "string",
- "compatibilityConditions": [
- "string"
], - "incompatibilityConditions": [
- "string"
]
}
], - "compartmentsConditions": [
- {
- "entityId": "string",
- "compatibilityConditions": [
- "string"
], - "incompatibilityConditions": [
- "string"
]
}
]
}, - "constraints": {
- "maxDistanceBetweenStartPoints": 0,
- "maxDistanceBetweenEndPoints": 0,
- "maxDurationBetweenStartPoints": 0,
- "maxDurationBetweenEndPoints": 0
}, - "geozoneSettings": [
- {
- "geozoneId": "string",
- "maxDistanceBetweenCustomerPoints": 0
}
], - "schedulesSettings": [
- {
- "scheduleSettingsId": "string",
- "allLocationsVisitRequired": true,
- "allowExtraLocations": true
}
], - "schedulesSettingsAssignments": [
- {
- "scheduleSettingsId": "string",
- "schedules": [
- "string"
]
}
]
}
]
}{- "taskId": "string",
- "tasksInQueue": 0
}