Error
A valid request URL is required to generate request examples{
"item": {
"id": "plan-AB",
"agencyId": "LND_Agency-42",
"resources": [
{
"id": "<string>",
"vehicleProfile": {
"type": "fly",
"kmph": 123
},
"workingTimeWindow": {
"begin": "2019-11-15T12:34:56Z",
"end": "2019-11-15T12:34:56Z"
},
"properties": {},
"state": {
"mode": "free",
"assignments": [
{
"stopId": "<string>",
"type": "stop",
"status": "fixed",
"arrivalTime": "2019-11-15T12:34:56Z",
"beginTime": "2019-11-15T12:34:56Z",
"departureTime": "2019-11-15T12:34:56Z"
}
]
},
"cost": {
"workedHours": {
"constantCost": 123,
"costFloor": 123,
"costCoeff": 123,
"overcostFloor": 123,
"overcostCoeff": 123
},
"km": {
"constantCost": 123,
"costFloor": 123,
"costCoeff": 123,
"overcostFloor": 123,
"overcostCoeff": 123
},
"using": 123,
"costsByStopTag": {},
"costsByCapacity": {},
"costPerCapacityPerTravelledKm": {
"weight": {
"costCoeff": 0.2
},
"volume": {
"costCoeff": 0.1
}
},
"costPerCapacityPerTravelledHour": {
"weight": {
"costCoeff": 0.05
}
}
},
"CO2EmissionCalculation": {
"km": {
"costCoeff": 0.55
},
"costPerCapacityPerTravelledKm": {
"weight": {
"costCoeff": 0.2
}
},
"costPerCapacityPerTravelledHour": {
"weight": {
"costCoeff": 0.05
}
}
},
"priority": 0,
"skills": [
"forklift",
"truck"
],
"preferredStopTags": [
"access:parking33",
"capa:bat22",
"setup:france"
],
"tags": [
"trailer"
],
"capacities": {
"volume": 9.5,
"weight": 2200,
"nbPackages": 23
},
"departure": {
"lon": 2.3269331,
"lat": 48.8812658
},
"arrival": {
"lon": 2.3269331,
"lat": 48.8812658
},
"maxWorkingDuration": "PT4M",
"maxDistanceInKm": 123,
"maxInterStopDistanceInKm": 50,
"maxInterStopDuration": "PT4M",
"breaks": [
{
"duration": "PT4M",
"timeWindow": {
"begin": "2019-11-15T12:34:56Z",
"end": "2019-11-15T12:34:56Z"
},
"type": "timeWindowBreak"
}
],
"operationDurationPolicies": [
{
"stopTags": [
"access:parking33",
"capa:bat22",
"setup:france"
]
}
],
"travelTimeCoefficient": 1.05,
"emptyThresholdByCapacity": {
"volume": 50,
"weight": 100,
"nbPackages": 23
},
"avoidEarlyLoadings": [
{
"stopTag": "depot1",
"capacities": [
"weight",
"volume"
]
}
]
}
],
"version": 42,
"running": true,
"status": {
"planVersionInSolution": 42,
"waitingRoom": {
"waitingVersion": 42,
"runningVersion": 42
},
"waitingTraffic": {
"waitingVersion": 42,
"runningVersion": 42
},
"creation": {
"waitingVersion": 42,
"runningVersion": 42
},
"optimization": {
"waitingVersion": 42,
"runningVersion": 42
}
},
"properties": {},
"nbResources": 1,
"orders": [
{
"id": "<string>",
"stops": [
{
"id": "<string>",
"position": {
"lon": 2.3269331,
"lat": 48.8812658
},
"type": "single",
"properties": {},
"tags": [
"access:parking33",
"capa:bat22",
"setup:france"
],
"kind": "delivery",
"operationDuration": "PT4M",
"capacities": {
"volume": 9.5,
"weight": 2200,
"nbPackages": 23
},
"authorizedTimeWindows": [
{
"begin": "2019-11-15T12:34:56Z",
"end": "2019-11-15T12:34:56Z",
"resourceTags": [
"subcontractorA",
"subcontractorB"
]
}
],
"preferredTimeWindows": [
{
"begin": "2019-11-15T12:34:56Z",
"end": "2019-11-15T12:34:56Z",
"resourceTags": [
"subcontractorA",
"subcontractorB"
]
}
]
}
],
"properties": {},
"priority": 0,
"optional": true,
"requiredSkills": [
"forklift",
"truck"
],
"successiveStops": true,
"maxStopSpan": "PT4M"
}
],
"nbOrders": 1,
"additionalOperationDurations": [
{
"resourceTag": "trailer",
"stopTag": "heavy",
"additionalOperationDuration": "PT4M"
}
],
"operationDurationPoliciesByResourceTag": {},
"forbiddenAssignments": [
{
"resourceTag": "trailer",
"stopTag": "heavy"
}
],
"incompatibleStopTags": [
[
"goat",
"cabbage"
],
[
"wolf",
"goat"
]
],
"additionalConstraints": [
{
"type": "atLeastOneValidCapacity",
"capacities": {
"volume": 9.5,
"weight": 2200,
"nbPackages": 23
},
"name": "<string>",
"resourceTags": [
"subcontractorA",
"subcontractorB"
]
}
],
"globalConstraints": [
{
"type": "maxCumulatedCost",
"costsByResourceTag": {},
"name": "<string>",
"maximum": 123
}
],
"accessDurationsByStopTag": {
"access:parking33": "PT5M"
},
"overlappingCapacitiesByStopTag": {
"capa:bat22": 3
},
"setupDurations": [
{
"fromStopTag": "setup:france",
"toStopTag": "setup:belgium",
"setupDuration": "PT4M"
}
],
"objectives": [
"maximizeMandatoryStops",
"minimizeDelay",
"minimizeCosts",
"minimizeResources",
"minimizeOverOverlappingCapacitiesOnStops",
"maximizeOptionalStops",
"maximizePreferredStops",
"minimizeWorkingDuration",
"minimizeDistance"
],
"maxOptimizationDuration": "PT4M",
"tz": "Europe/Paris",
"createdAt": "2019-11-15T12:34:56Z",
"createdBy": "<string>",
"updatedAt": "2019-11-15T12:34:56Z",
"updatedBy": "<string>",
"archivedAt": null,
"lateDeparture": false,
"sharedCapacities": false,
"emptyThresholdByCapacityByResourceTag": {
"heavy": {
"weight": 150,
"volume": 75
},
"*": {
"weight": 50
}
},
"avoidEarlyLoadingsByResourceTag": {
"*": [
{
"stopTag": "depot1",
"capacities": [
"weight",
"volume"
]
}
],
"heavy": [
{
"stopTag": "warehouse"
}
]
},
"CO2EmissionCalculationByResourceTag": {
"resTag2": {
"km": {
"costCoeff": 0.55
},
"costPerCapacityPerTravelledKm": {
"weight": {
"costCoeff": 0.2
}
}
}
}
},
"agencyId": "LND_Agency-42",
"planId": "plan-AB",
"planVersion": 42
}{
"errors": [
{
"code": "<string>",
"message": "<string>",
"properties": {}
}
]
}{
"errors": [
{
"code": "<string>",
"message": "<string>",
"properties": {}
}
]
}{
"errors": [
{
"code": "<string>",
"message": "<string>",
"properties": {}
}
]
}{
"errors": [
{
"code": "<string>",
"message": "<string>",
"properties": {}
}
]
}{
"errors": [
{
"code": "<string>",
"message": "<string>",
"properties": {}
}
]
}Resource
Forbid a resource from doing a stop, and return the updated plan
Forbidding a resource from doing a stop is performed internally by adding a forbidden assignment in the list of additional constraints of the plan. The forbidden assignment relies on:
- a generated resource tag, based on the id of the resource (example:
generatedTag:$resource-2$:forbid), - a generated stop tag, based on the id of the parent order of the stop (example:
generatedTag:$order-1$:forbid).
Important: all the sibling stops receive this same stop tag, which means that all the stops of the order become forbidden for the resource.
PUT
/
agencies
/
{agencyId}
/
plans
/
{planId}
/
resources
/
{resourceId}
/
forbid
/
{stopId}
Error
A valid request URL is required to generate request examples{
"item": {
"id": "plan-AB",
"agencyId": "LND_Agency-42",
"resources": [
{
"id": "<string>",
"vehicleProfile": {
"type": "fly",
"kmph": 123
},
"workingTimeWindow": {
"begin": "2019-11-15T12:34:56Z",
"end": "2019-11-15T12:34:56Z"
},
"properties": {},
"state": {
"mode": "free",
"assignments": [
{
"stopId": "<string>",
"type": "stop",
"status": "fixed",
"arrivalTime": "2019-11-15T12:34:56Z",
"beginTime": "2019-11-15T12:34:56Z",
"departureTime": "2019-11-15T12:34:56Z"
}
]
},
"cost": {
"workedHours": {
"constantCost": 123,
"costFloor": 123,
"costCoeff": 123,
"overcostFloor": 123,
"overcostCoeff": 123
},
"km": {
"constantCost": 123,
"costFloor": 123,
"costCoeff": 123,
"overcostFloor": 123,
"overcostCoeff": 123
},
"using": 123,
"costsByStopTag": {},
"costsByCapacity": {},
"costPerCapacityPerTravelledKm": {
"weight": {
"costCoeff": 0.2
},
"volume": {
"costCoeff": 0.1
}
},
"costPerCapacityPerTravelledHour": {
"weight": {
"costCoeff": 0.05
}
}
},
"CO2EmissionCalculation": {
"km": {
"costCoeff": 0.55
},
"costPerCapacityPerTravelledKm": {
"weight": {
"costCoeff": 0.2
}
},
"costPerCapacityPerTravelledHour": {
"weight": {
"costCoeff": 0.05
}
}
},
"priority": 0,
"skills": [
"forklift",
"truck"
],
"preferredStopTags": [
"access:parking33",
"capa:bat22",
"setup:france"
],
"tags": [
"trailer"
],
"capacities": {
"volume": 9.5,
"weight": 2200,
"nbPackages": 23
},
"departure": {
"lon": 2.3269331,
"lat": 48.8812658
},
"arrival": {
"lon": 2.3269331,
"lat": 48.8812658
},
"maxWorkingDuration": "PT4M",
"maxDistanceInKm": 123,
"maxInterStopDistanceInKm": 50,
"maxInterStopDuration": "PT4M",
"breaks": [
{
"duration": "PT4M",
"timeWindow": {
"begin": "2019-11-15T12:34:56Z",
"end": "2019-11-15T12:34:56Z"
},
"type": "timeWindowBreak"
}
],
"operationDurationPolicies": [
{
"stopTags": [
"access:parking33",
"capa:bat22",
"setup:france"
]
}
],
"travelTimeCoefficient": 1.05,
"emptyThresholdByCapacity": {
"volume": 50,
"weight": 100,
"nbPackages": 23
},
"avoidEarlyLoadings": [
{
"stopTag": "depot1",
"capacities": [
"weight",
"volume"
]
}
]
}
],
"version": 42,
"running": true,
"status": {
"planVersionInSolution": 42,
"waitingRoom": {
"waitingVersion": 42,
"runningVersion": 42
},
"waitingTraffic": {
"waitingVersion": 42,
"runningVersion": 42
},
"creation": {
"waitingVersion": 42,
"runningVersion": 42
},
"optimization": {
"waitingVersion": 42,
"runningVersion": 42
}
},
"properties": {},
"nbResources": 1,
"orders": [
{
"id": "<string>",
"stops": [
{
"id": "<string>",
"position": {
"lon": 2.3269331,
"lat": 48.8812658
},
"type": "single",
"properties": {},
"tags": [
"access:parking33",
"capa:bat22",
"setup:france"
],
"kind": "delivery",
"operationDuration": "PT4M",
"capacities": {
"volume": 9.5,
"weight": 2200,
"nbPackages": 23
},
"authorizedTimeWindows": [
{
"begin": "2019-11-15T12:34:56Z",
"end": "2019-11-15T12:34:56Z",
"resourceTags": [
"subcontractorA",
"subcontractorB"
]
}
],
"preferredTimeWindows": [
{
"begin": "2019-11-15T12:34:56Z",
"end": "2019-11-15T12:34:56Z",
"resourceTags": [
"subcontractorA",
"subcontractorB"
]
}
]
}
],
"properties": {},
"priority": 0,
"optional": true,
"requiredSkills": [
"forklift",
"truck"
],
"successiveStops": true,
"maxStopSpan": "PT4M"
}
],
"nbOrders": 1,
"additionalOperationDurations": [
{
"resourceTag": "trailer",
"stopTag": "heavy",
"additionalOperationDuration": "PT4M"
}
],
"operationDurationPoliciesByResourceTag": {},
"forbiddenAssignments": [
{
"resourceTag": "trailer",
"stopTag": "heavy"
}
],
"incompatibleStopTags": [
[
"goat",
"cabbage"
],
[
"wolf",
"goat"
]
],
"additionalConstraints": [
{
"type": "atLeastOneValidCapacity",
"capacities": {
"volume": 9.5,
"weight": 2200,
"nbPackages": 23
},
"name": "<string>",
"resourceTags": [
"subcontractorA",
"subcontractorB"
]
}
],
"globalConstraints": [
{
"type": "maxCumulatedCost",
"costsByResourceTag": {},
"name": "<string>",
"maximum": 123
}
],
"accessDurationsByStopTag": {
"access:parking33": "PT5M"
},
"overlappingCapacitiesByStopTag": {
"capa:bat22": 3
},
"setupDurations": [
{
"fromStopTag": "setup:france",
"toStopTag": "setup:belgium",
"setupDuration": "PT4M"
}
],
"objectives": [
"maximizeMandatoryStops",
"minimizeDelay",
"minimizeCosts",
"minimizeResources",
"minimizeOverOverlappingCapacitiesOnStops",
"maximizeOptionalStops",
"maximizePreferredStops",
"minimizeWorkingDuration",
"minimizeDistance"
],
"maxOptimizationDuration": "PT4M",
"tz": "Europe/Paris",
"createdAt": "2019-11-15T12:34:56Z",
"createdBy": "<string>",
"updatedAt": "2019-11-15T12:34:56Z",
"updatedBy": "<string>",
"archivedAt": null,
"lateDeparture": false,
"sharedCapacities": false,
"emptyThresholdByCapacityByResourceTag": {
"heavy": {
"weight": 150,
"volume": 75
},
"*": {
"weight": 50
}
},
"avoidEarlyLoadingsByResourceTag": {
"*": [
{
"stopTag": "depot1",
"capacities": [
"weight",
"volume"
]
}
],
"heavy": [
{
"stopTag": "warehouse"
}
]
},
"CO2EmissionCalculationByResourceTag": {
"resTag2": {
"km": {
"costCoeff": 0.55
},
"costPerCapacityPerTravelledKm": {
"weight": {
"costCoeff": 0.2
}
}
}
}
},
"agencyId": "LND_Agency-42",
"planId": "plan-AB",
"planVersion": 42
}{
"errors": [
{
"code": "<string>",
"message": "<string>",
"properties": {}
}
]
}{
"errors": [
{
"code": "<string>",
"message": "<string>",
"properties": {}
}
]
}{
"errors": [
{
"code": "<string>",
"message": "<string>",
"properties": {}
}
]
}{
"errors": [
{
"code": "<string>",
"message": "<string>",
"properties": {}
}
]
}{
"errors": [
{
"code": "<string>",
"message": "<string>",
"properties": {}
}
]
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
The agency id.
Pattern:
^[A-Z]{3,6}_[a-zA-Z0-9-._~:@!$,]+$Example:
"LND_Agency-42"
The plan id. At least one character among those allowed: unaccented alpha-numeric characters, "-", ".", "_", "~", ":", "@", "!", "$", ",".
Pattern:
^[a-zA-Z0-9-._~:@!$,]+$The resource id. At least one character among those allowed: unaccented alpha-numeric characters, "-", ".", "_", "~", ":", "@", "!", "$", ",".
Pattern:
^[a-zA-Z0-9-._~:@!$,]+$The stop id. At least one character among those allowed: unaccented alpha-numeric characters, "-", ".", "_", "~", ":", "@", "!", "$", ",".
Pattern:
^[a-zA-Z0-9-._~:@!$,]+$Query Parameters
If true, on an archived item, the requested action will be forced and the item will be unarchived.
Response
Updated plan response.
[TO_VALIDATE] Description pending review by a Kardinal engineer.
A plan for a date and agency, with resource and orders associated.
Show child attributes
Show child attributes
The agency id.
Pattern:
^[A-Z]{3,6}_[a-zA-Z0-9-._~:@!$,]+$Example:
"LND_Agency-42"
The plan id.
Pattern:
^[a-zA-Z0-9-._~:@!$,]+$Example:
"plan-AB"
The plan version.
Required range:
x >= 1Example:
42
⌘I