VRt.Agro [AG] (6.20.2289)

Veeroute Support Team: servicedesk@veeroute.comLicense: Proprietary

Veeroute Agro 的软件界面.

主站点

描述

该服务旨在计算生产设施的工作计划.

对象概述

objects

实体图

erd

Plan

Production plan calculation.

Planning (SYNC)

Production plan calculation.

Authorizations:

ApiKeyAuth

Request Body schema: application/json
required

Data for calculation.

required	Array of objects (crop) [ 1 .. 501 ] items unique List of crops.
required	Array of objects (field) [ 1 .. 20001 ] items unique List of fields.
	Array of objects (elevator) [ 1 .. 501 ] items unique List of elevators.
required	Array of objects (factory) [ 1 .. 501 ] items unique List of factories.
required	Array of objects (market) [ 1 .. 501 ] items unique List of markets.
required	Array of objects (movement_matrix) [ 1 .. 8040402 ] items unique Matrix describing the cost (in kilometers and monetary units) of moving grain between objects (in both directions). If there is no corresponding entry in the matrix between the objects, the movement of grain between them is considered impossible.
	Array of objects (leftover) [ 0 .. 25001 ] items List of leftovers.
required	object (plan_settings) Plan settings.

Responses

Response Schema: application/json

required	object (tracedata) Data for request tracing.
required	Array of objects (project) [ 0 .. 1000001 ] items Production plan. The sequence of work.
required	object (plan_statistics) General statistics.
	Array of objects (entity_warning_list) [ 0 .. 100001 ] items List of warnings. Depending on the flag `calculation_settings.treat_warnings_as_errors` - triggered checks are interpreted as errors or result in the removal of incorrect data from the calculation.
	object (unplanned_items) Unplanned items list.
progress required	integer<int32> (calculation_progress) [ 0 .. 100 ] Calculation progress as a percentage. The progress displays the current number of completed steps.
required	object (calculation_info) Calculation information.

Request samples

Payload
Python

Content type

application/json

{"crops": [{"key": "bean",
"base_humidity": 180,
"compatible_storage_types": ["granary"
],
"compatible_silo_types": [ ],
"attributes": [{"key": "full_name",
"value": "Бобы сои"
}
]
}
],
"fields": [{"key": "field_1",
"crop_key": "bean",
"capacity_forecast": [{"date_window": {"from": "2023-01-01",
"to": "2023-01-05"
},
"capacity": 1000
}
],
"humidity_forecast": [{"date_window": {"from": "2023-01-01",
"to": "2023-01-03"
},
"humidity": 220
},
{"date_window": {"from": "2023-01-04",
"to": "2023-01-05"
},
"humidity": 170
}
],
"amount": 5000,
"attributes": [{"key": "full_number",
"value": "57-4-6-130-227"
}
]
}
],
"elevators": [{"key": "elevator_1",
"gate": {"key": "gate_1",
"input_capacity_forecast": [{"date_window": {"from": "2023-01-01",
"to": "2023-01-10"
},
"capacity": 100
}
],
"output_capacity_forecast": [{"date_window": {"from": "2023-01-01",
"to": "2023-01-10"
},
"capacity": 100
}
]
},
"dryers": [{"key": "dryer_1",
"chamber_variants": [{"crop_key": "bean",
"capacity_forecast": [{"date_window": {"from": "2023-01-01",
"to": "2023-01-10"
},
"capacity": 15000
}
],
"productivity_forecast": [{"date_window": {"from": "2023-01-01",
"to": "2023-01-10"
},
"productivity": 5000
}
]
}
]
}
],
"storages": [{"key": "storage_1",
"type": "granary",
"capacity_forecast": [{"date_window": {"from": "2023-01-01",
"to": "2023-01-05"
},
"capacity": 5000
},
{"date_window": {"from": "2023-01-06",
"to": "2023-01-10"
},
"capacity": 4100
}
]
}
],
"silos": [{"key": "silo_1",
"type": "trench",
"deployment_cost": 1888,
"capacity_forecast": [{"date_window": {"from": "2023-01-01",
"to": "2023-07-15"
},
"capacity": 50000
}
]
}
],
"attributes": [ ]
}
],
"factories": [{"key": "factory_1",
"gate": {"key": "factory_gate_1",
"input_capacity_forecast": [{"date_window": {"from": "2023-01-01",
"to": "2023-01-10"
},
"capacity": 2000
}
],
"output_capacity_forecast": [ ]
},
"dryers": [{"key": "factory_dryer_1",
"chamber_variants": [{"crop_key": "bean",
"capacity_forecast": [{"date_window": {"from": "2023-01-01",
"to": "2023-01-10"
},
"capacity": 17000
}
],
"productivity_forecast": [{"date_window": {"from": "2023-01-01",
"to": "2023-01-10"
},
"productivity": 2700
}
]
}
]
}
],
"bunkers": [{"key": "bunker_1",
"capacity_forecast": [{"date_window": {"from": "2023-01-01",
"to": "2023-01-10"
},
"capacity": 5000
}
]
}
],
"consumers": [{"key": "factory_line_1",
"crop_key": "bean",
"consumption_forecast": [{"date_window": {"from": "2023-01-05",
"to": "2023-01-11"
},
"capacity": 500
},
{"date_window": {"from": "2023-01-12",
"to": "2023-01-15"
},
"capacity": 20
}
],
"stock_forecast": [{"date_window": {"from": "2023-01-01",
"to": "2023-01-12"
},
"min_stock_days": 2
}
]
}
],
"attributes": [ ]
}
],
"markets": [{"key": "market_1",
"contracts": [{"key": "contract_1",
"type": "BUY",
"target_keys": ["elevator_1"
],
"pricelist": [{"crop_key": "bean",
"price_forecast": [{"date_window": {"from": "2023-01-01",
"to": "2023-01-15"
},
"price": 280
}
]
}
]
},
{"key": "contract_2",
"type": "SELL",
"target_keys": ["factory_1"
],
"pricelist": [{"crop_key": "bean",
"price_forecast": [{"date_window": {"from": "2023-01-01",
"to": "2023-01-15"
},
"price": 320
}
]
}
]
}
],
"attributes": [ ]
}
],
"movement_matrix": [{"source_key": "field_1",
"destination_key": "factory_1",
"distance": 100,
"cost_per_transport": 5000
},
{"source_key": "field_1",
"destination_key": "elevator_1",
"distance": 70,
"cost_per_transport": 5000
},
{"source_key": "elevator_1",
"destination_key": "factory_1",
"distance": 40,
"cost_per_transport": 5000
},
{"source_key": "elevator_1",
"destination_key": "market_1",
"distance": 5,
"cost_per_transport": 5000
},
{"source_key": "factory_1",
"destination_key": "market_1",
"distance": 5,
"cost_per_transport": 5000
}
],
"leftovers": [{"crop_key": "bean",
"humidity": 50,
"target_key": "field_1",
"target_detail_key": null,
"amount": 4990
}
],
"plan_settings": {"project_settings": {"configuration": "OPTIMIZE_DISTANCE",
"start_date": "2023-01-01",
"end_date": "2023-01-15",
"transport_capacity": 23
},
"calculation_settings": {"result_ttl": "PT20M",
"treat_warnings_as_errors": false
}
}
}

Response samples

Content type

application/json

{"tracedata": {"code": "69c507e4-7c2a-46fd-a862-a503cf27b1a3",
"client": "veeroute_|_example",
"server": "Agro:client",
"service": "AGRO",
"operation": "run_plan_calculation",
"time": "2024-02-21T16:55:35.370332Z"
},
"project": [{"type": "RELOCATE",
"crop_key": "bean",
"source": {"date": "2023-09-15",
"target_key": "field_1",
"target_type": "FIELD",
"crop_type": "DRY",
"mass": 100,
"humidity": 15
},
"destination": {"date": "2023-09-15",
"target_key": "factory_1",
"target_type": "FACTORY",
"crop_type": "DRY",
"mass": 100,
"humidity": 15
},
"measurements": {"distance": 50,
"cost": 4500
}
}
],
"statistics": {"days_count": 1,
"crops_count": 1,
"fields_count": 1,
"fields_part_count": 0,
"elevators_count": 1,
"factory_count": 1,
"markets_count": 1,
"total_distance": 1888,
"total_cost": 100.1,
"unplanned_crops_count": 0,
"unplanned_fields_count": 0,
"unplanned_elevators_count": 0,
"unplanned_factories_count": 0,
"unplanned_markets_count": 0
},
"progress": 100,
"info": {"status": "FINISHED_IN_TIME",
"result_version": 142,
"preparing_time": "PT1M10S",
"business_validation_time": "PT1M10S",
"math_validation_time": "PT1M10S",
"waiting_time": "PT15S",
"calculation_time": "PT1M10S"
},
"warnings": [ ]
}

Planning (ASYNC)

The result can be obtained using the result method, removing - with delete.

Authorizations:

ApiKeyAuth

Request Body schema: application/json
required

Data for calculation.

required	Array of objects (crop) [ 1 .. 501 ] items unique List of crops.
required	Array of objects (field) [ 1 .. 20001 ] items unique List of fields.
	Array of objects (elevator) [ 1 .. 501 ] items unique List of elevators.
required	Array of objects (factory) [ 1 .. 501 ] items unique List of factories.
required	Array of objects (market) [ 1 .. 501 ] items unique List of markets.
required	Array of objects (movement_matrix) [ 1 .. 8040402 ] items unique Matrix describing the cost (in kilometers and monetary units) of moving grain between objects (in both directions). If there is no corresponding entry in the matrix between the objects, the movement of grain between them is considered impossible.
	Array of objects (leftover) [ 0 .. 25001 ] items List of leftovers.
required	object (plan_settings) Plan settings.

Responses

Response Schema: application/json

required	object (tracedata) Data for request tracing.
id required	string<uuid> (calculation_id) Calculation identifier.

Request samples

Payload

Content type

application/json

{"crops": [{"key": "bean",
"base_humidity": 180,
"compatible_storage_types": ["granary"
],
"compatible_silo_types": [ ],
"attributes": [{"key": "full_name",
"value": "Бобы сои"
}
]
}
],
"fields": [{"key": "field_1",
"crop_key": "bean",
"capacity_forecast": [{"date_window": {"from": "2023-01-01",
"to": "2023-01-05"
},
"capacity": 1000
}
],
"humidity_forecast": [{"date_window": {"from": "2023-01-01",
"to": "2023-01-03"
},
"humidity": 220
},
{"date_window": {"from": "2023-01-04",
"to": "2023-01-05"
},
"humidity": 170
}
],
"amount": 5000,
"attributes": [{"key": "full_number",
"value": "57-4-6-130-227"
}
]
}
],
"elevators": [{"key": "elevator_1",
"gate": {"key": "gate_1",
"input_capacity_forecast": [{"date_window": {"from": "2023-01-01",
"to": "2023-01-10"
},
"capacity": 100
}
],
"output_capacity_forecast": [{"date_window": {"from": "2023-01-01",
"to": "2023-01-10"
},
"capacity": 100
}
]
},
"dryers": [{"key": "dryer_1",
"chamber_variants": [{"crop_key": "bean",
"capacity_forecast": [{"date_window": {"from": "2023-01-01",
"to": "2023-01-10"
},
"capacity": 15000
}
],
"productivity_forecast": [{"date_window": {"from": "2023-01-01",
"to": "2023-01-10"
},
"productivity": 5000
}
]
}
]
}
],
"storages": [{"key": "storage_1",
"type": "granary",
"capacity_forecast": [{"date_window": {"from": "2023-01-01",
"to": "2023-01-05"
},
"capacity": 5000
},
{"date_window": {"from": "2023-01-06",
"to": "2023-01-10"
},
"capacity": 4100
}
]
}
],
"silos": [{"key": "silo_1",
"type": "trench",
"deployment_cost": 1888,
"capacity_forecast": [{"date_window": {"from": "2023-01-01",
"to": "2023-07-15"
},
"capacity": 50000
}
]
}
],
"attributes": [ ]
}
],
"factories": [{"key": "factory_1",
"gate": {"key": "factory_gate_1",
"input_capacity_forecast": [{"date_window": {"from": "2023-01-01",
"to": "2023-01-10"
},
"capacity": 2000
}
],
"output_capacity_forecast": [ ]
},
"dryers": [{"key": "factory_dryer_1",
"chamber_variants": [{"crop_key": "bean",
"capacity_forecast": [{"date_window": {"from": "2023-01-01",
"to": "2023-01-10"
},
"capacity": 17000
}
],
"productivity_forecast": [{"date_window": {"from": "2023-01-01",
"to": "2023-01-10"
},
"productivity": 2700
}
]
}
]
}
],
"bunkers": [{"key": "bunker_1",
"capacity_forecast": [{"date_window": {"from": "2023-01-01",
"to": "2023-01-10"
},
"capacity": 5000
}
]
}
],
"consumers": [{"key": "factory_line_1",
"crop_key": "bean",
"consumption_forecast": [{"date_window": {"from": "2023-01-05",
"to": "2023-01-11"
},
"capacity": 500
},
{"date_window": {"from": "2023-01-12",
"to": "2023-01-15"
},
"capacity": 20
}
],
"stock_forecast": [{"date_window": {"from": "2023-01-01",
"to": "2023-01-12"
},
"min_stock_days": 2
}
]
}
],
"attributes": [ ]
}
],
"markets": [{"key": "market_1",
"contracts": [{"key": "contract_1",
"type": "BUY",
"target_keys": ["elevator_1"
],
"pricelist": [{"crop_key": "bean",
"price_forecast": [{"date_window": {"from": "2023-01-01",
"to": "2023-01-15"
},
"price": 280
}
]
}
]
},
{"key": "contract_2",
"type": "SELL",
"target_keys": ["factory_1"
],
"pricelist": [{"crop_key": "bean",
"price_forecast": [{"date_window": {"from": "2023-01-01",
"to": "2023-01-15"
},
"price": 320
}
]
}
]
}
],
"attributes": [ ]
}
],
"movement_matrix": [{"source_key": "field_1",
"destination_key": "factory_1",
"distance": 100,
"cost_per_transport": 5000
},
{"source_key": "field_1",
"destination_key": "elevator_1",
"distance": 70,
"cost_per_transport": 5000
},
{"source_key": "elevator_1",
"destination_key": "factory_1",
"distance": 40,
"cost_per_transport": 5000
},
{"source_key": "elevator_1",
"destination_key": "market_1",
"distance": 5,
"cost_per_transport": 5000
},
{"source_key": "factory_1",
"destination_key": "market_1",
"distance": 5,
"cost_per_transport": 5000
}
],
"leftovers": [{"crop_key": "bean",
"humidity": 50,
"target_key": "field_1",
"target_detail_key": null,
"amount": 4990
}
],
"plan_settings": {"project_settings": {"configuration": "OPTIMIZE_DISTANCE",
"start_date": "2023-01-01",
"end_date": "2023-01-15",
"transport_capacity": 23
},
"calculation_settings": {"result_ttl": "PT20M",
"treat_warnings_as_errors": false
}
}
}

Response samples

Content type

application/json

{"tracedata": {"code": "11111111-2222-3333-4444-555555555555",
"client": "company_|_username",
"server": "server_name",
"service": "UNIVERSAL",
"operation": "run_plan_calculation",
"time": "2024-02-21T09:30:00+03:00"
},
"id": "11111111-2222-3333-4444-555555555555"
}

Calculation state

Read calculation state by the calculation identifier.

Authorizations:

ApiKeyAuth

path Parameters

id

required

string<uuid> (calculation_id)

Example: 11111111-2222-3333-4444-555555555555

计算标识符

Responses

Response Schema: application/json

required	object (tracedata) Data for request tracing.
progress required	integer<int32> (calculation_progress) [ 0 .. 100 ] Calculation progress as a percentage. The progress displays the current number of completed steps.
required	object (calculation_info) Calculation information.

Response samples

Content type

application/json

{"tracedata": {"code": "11111111-2222-3333-4444-555555555555",
"client": "company_|_username",
"server": "server_name",
"service": "UNIVERSAL",
"operation": "run_plan_calculation",
"time": "2024-02-21T09:30:00+03:00"
},
"progress": 52,
"info": {"status": "FINISHED_IN_TIME",
"result_version": 133,
"preparing_time": "P1Y1M1DT2H12M34.3S",
"business_validation_time": "P1Y1M1DT2H12M34.3S",
"math_validation_time": "P1Y1M1DT2H12M34.3S",
"waiting_time": "P1Y1M1DT2H12M34.3S",
"calculation_time": "P1Y1M1DT2H12M34.3S"
}
}

Cancel calculation

Cancel calculation process by the calculation identifier.

Authorizations:

ApiKeyAuth

path Parameters

id

required

string<uuid> (calculation_id)

Example: 11111111-2222-3333-4444-555555555555

计算标识符

Responses

Response samples

Content type

application/json

{"tracedata": {"code": "11111111-2222-3333-4444-555555555555",
"client": "veeroute_|_example",
"server": "server_name",
"service": "AGRO",
"operation": "run_plan_calculation",
"time": "2024-02-21T09:30:00+03:00"
},
"message": "bad task data",
"schema_errors": [ ],
"logical_errors": [ ],
"warnings": [ ]
}

Getting the result

Getting the result based on the calculation identifier.

Authorizations:

ApiKeyAuth

path Parameters

id

required

string<uuid> (calculation_id)

Example: 11111111-2222-3333-4444-555555555555

计算标识符

Responses

Response Schema: application/json

required	object (tracedata) Data for request tracing.
required	Array of objects (project) [ 0 .. 1000001 ] items Production plan. The sequence of work.
required	object (plan_statistics) General statistics.
	Array of objects (entity_warning_list) [ 0 .. 100001 ] items List of warnings. Depending on the flag `calculation_settings.treat_warnings_as_errors` - triggered checks are interpreted as errors or result in the removal of incorrect data from the calculation.
	object (unplanned_items) Unplanned items list.
progress required	integer<int32> (calculation_progress) [ 0 .. 100 ] Calculation progress as a percentage. The progress displays the current number of completed steps.
required	object (calculation_info) Calculation information.

Response Schema: application/json

required	object (tracedata) Data for request tracing.
required	Array of objects (project) [ 0 .. 1000001 ] items Production plan. The sequence of work.
required	object (plan_statistics) General statistics.
	Array of objects (entity_warning_list) [ 0 .. 100001 ] items List of warnings. Depending on the flag `calculation_settings.treat_warnings_as_errors` - triggered checks are interpreted as errors or result in the removal of incorrect data from the calculation.
	object (unplanned_items) Unplanned items list.
progress required	integer<int32> (calculation_progress) [ 0 .. 100 ] Calculation progress as a percentage. The progress displays the current number of completed steps.
required	object (calculation_info) Calculation information.

Response samples

Content type

application/json

{"tracedata": {"code": "69c507e4-7c2a-46fd-a862-a503cf27b1a3",
"client": "veeroute_|_example",
"server": "Agro:client",
"service": "AGRO",
"operation": "run_plan_calculation",
"time": "2024-02-21T16:55:35.370332Z"
},
"project": [{"type": "RELOCATE",
"crop_key": "bean",
"source": {"date": "2023-09-15",
"target_key": "field_1",
"target_type": "FIELD",
"crop_type": "DRY",
"mass": 100,
"humidity": 15
},
"destination": {"date": "2023-09-15",
"target_key": "factory_1",
"target_type": "FACTORY",
"crop_type": "DRY",
"mass": 100,
"humidity": 15
},
"measurements": {"distance": 50,
"cost": 4500
}
}
],
"statistics": {"days_count": 1,
"crops_count": 1,
"fields_count": 1,
"fields_part_count": 0,
"elevators_count": 1,
"factory_count": 1,
"markets_count": 1,
"total_distance": 1888,
"total_cost": 100.1,
"unplanned_crops_count": 0,
"unplanned_fields_count": 0,
"unplanned_elevators_count": 0,
"unplanned_factories_count": 0,
"unplanned_markets_count": 0
},
"progress": 100,
"info": {"status": "FINISHED_IN_TIME",
"result_version": 142,
"preparing_time": "PT1M10S",
"business_validation_time": "PT1M10S",
"math_validation_time": "PT1M10S",
"waiting_time": "PT15S",
"calculation_time": "PT1M10S"
},
"warnings": [ ]
}

Result removal

Removal of the planning result by the calculation identifier.

Authorizations:

ApiKeyAuth

path Parameters

id

required

string<uuid> (calculation_id)

Example: 11111111-2222-3333-4444-555555555555

计算标识符

Responses

Response samples

Content type

application/json

{"tracedata": {"code": "11111111-2222-3333-4444-555555555555",
"client": "veeroute_|_example",
"server": "server_name",
"service": "AGRO",
"operation": "run_plan_calculation",
"time": "2024-02-21T09:30:00+03:00"
},
"message": "bad task data",
"schema_errors": [ ],
"logical_errors": [ ],
"warnings": [ ]
}

Data validation

Checking data before planning.

Authorizations:

ApiKeyAuth

Request Body schema: application/json
required

Data for calculation.

required	Array of objects (crop) [ 1 .. 501 ] items unique List of crops.
required	Array of objects (field) [ 1 .. 20001 ] items unique List of fields.
	Array of objects (elevator) [ 1 .. 501 ] items unique List of elevators.
required	Array of objects (factory) [ 1 .. 501 ] items unique List of factories.
required	Array of objects (market) [ 1 .. 501 ] items unique List of markets.
required	Array of objects (movement_matrix) [ 1 .. 8040402 ] items unique Matrix describing the cost (in kilometers and monetary units) of moving grain between objects (in both directions). If there is no corresponding entry in the matrix between the objects, the movement of grain between them is considered impossible.
	Array of objects (leftover) [ 0 .. 25001 ] items List of leftovers.
required	object (plan_settings) Plan settings.

Responses

Response Schema: application/json

required	object (tracedata) Data for request tracing.
required	Array of objects (entity_warning_list) [ 0 .. 100001 ] items List of warnings. Depending on the flag `calculation_settings.treat_warnings_as_errors` - triggered checks are interpreted as errors or result in the removal of incorrect data from the calculation.

Request samples

Payload

Content type

application/json

{"crops": [{"key": "bean",
"base_humidity": 180,
"compatible_storage_types": ["granary"
],
"compatible_silo_types": [ ],
"attributes": [{"key": "full_name",
"value": "Бобы сои"
}
]
}
],
"fields": [{"key": "field_1",
"crop_key": "bean",
"capacity_forecast": [{"date_window": {"from": "2023-01-01",
"to": "2023-01-05"
},
"capacity": 1000
}
],
"humidity_forecast": [{"date_window": {"from": "2023-01-01",
"to": "2023-01-03"
},
"humidity": 220
},
{"date_window": {"from": "2023-01-04",
"to": "2023-01-05"
},
"humidity": 170
}
],
"amount": 5000,
"attributes": [{"key": "full_number",
"value": "57-4-6-130-227"
}
]
}
],
"elevators": [{"key": "elevator_1",
"gate": {"key": "gate_1",
"input_capacity_forecast": [{"date_window": {"from": "2023-01-01",
"to": "2023-01-10"
},
"capacity": 100
}
],
"output_capacity_forecast": [{"date_window": {"from": "2023-01-01",
"to": "2023-01-10"
},
"capacity": 100
}
]
},
"dryers": [{"key": "dryer_1",
"chamber_variants": [{"crop_key": "bean",
"capacity_forecast": [{"date_window": {"from": "2023-01-01",
"to": "2023-01-10"
},
"capacity": 15000
}
],
"productivity_forecast": [{"date_window": {"from": "2023-01-01",
"to": "2023-01-10"
},
"productivity": 5000
}
]
}
]
}
],
"storages": [{"key": "storage_1",
"type": "granary",
"capacity_forecast": [{"date_window": {"from": "2023-01-01",
"to": "2023-01-05"
},
"capacity": 5000
},
{"date_window": {"from": "2023-01-06",
"to": "2023-01-10"
},
"capacity": 4100
}
]
}
],
"silos": [{"key": "silo_1",
"type": "trench",
"deployment_cost": 1888,
"capacity_forecast": [{"date_window": {"from": "2023-01-01",
"to": "2023-07-15"
},
"capacity": 50000
}
]
}
],
"attributes": [ ]
}
],
"factories": [{"key": "factory_1",
"gate": {"key": "factory_gate_1",
"input_capacity_forecast": [{"date_window": {"from": "2023-01-01",
"to": "2023-01-10"
},
"capacity": 2000
}
],
"output_capacity_forecast": [ ]
},
"dryers": [{"key": "factory_dryer_1",
"chamber_variants": [{"crop_key": "bean",
"capacity_forecast": [{"date_window": {"from": "2023-01-01",
"to": "2023-01-10"
},
"capacity": 17000
}
],
"productivity_forecast": [{"date_window": {"from": "2023-01-01",
"to": "2023-01-10"
},
"productivity": 2700
}
]
}
]
}
],
"bunkers": [{"key": "bunker_1",
"capacity_forecast": [{"date_window": {"from": "2023-01-01",
"to": "2023-01-10"
},
"capacity": 5000
}
]
}
],
"consumers": [{"key": "factory_line_1",
"crop_key": "bean",
"consumption_forecast": [{"date_window": {"from": "2023-01-05",
"to": "2023-01-11"
},
"capacity": 500
},
{"date_window": {"from": "2023-01-12",
"to": "2023-01-15"
},
"capacity": 20
}
],
"stock_forecast": [{"date_window": {"from": "2023-01-01",
"to": "2023-01-12"
},
"min_stock_days": 2
}
]
}
],
"attributes": [ ]
}
],
"markets": [{"key": "market_1",
"contracts": [{"key": "contract_1",
"type": "BUY",
"target_keys": ["elevator_1"
],
"pricelist": [{"crop_key": "bean",
"price_forecast": [{"date_window": {"from": "2023-01-01",
"to": "2023-01-15"
},
"price": 280
}
]
}
]
},
{"key": "contract_2",
"type": "SELL",
"target_keys": ["factory_1"
],
"pricelist": [{"crop_key": "bean",
"price_forecast": [{"date_window": {"from": "2023-01-01",
"to": "2023-01-15"
},
"price": 320
}
]
}
]
}
],
"attributes": [ ]
}
],
"movement_matrix": [{"source_key": "field_1",
"destination_key": "factory_1",
"distance": 100,
"cost_per_transport": 5000
},
{"source_key": "field_1",
"destination_key": "elevator_1",
"distance": 70,
"cost_per_transport": 5000
},
{"source_key": "elevator_1",
"destination_key": "factory_1",
"distance": 40,
"cost_per_transport": 5000
},
{"source_key": "elevator_1",
"destination_key": "market_1",
"distance": 5,
"cost_per_transport": 5000
},
{"source_key": "factory_1",
"destination_key": "market_1",
"distance": 5,
"cost_per_transport": 5000
}
],
"leftovers": [{"crop_key": "bean",
"humidity": 50,
"target_key": "field_1",
"target_detail_key": null,
"amount": 4990
}
],
"plan_settings": {"project_settings": {"configuration": "OPTIMIZE_DISTANCE",
"start_date": "2023-01-01",
"end_date": "2023-01-15",
"transport_capacity": 23
},
"calculation_settings": {"result_ttl": "PT20M",
"treat_warnings_as_errors": false
}
}
}

Response samples

Content type

application/json

{"tracedata": {"code": "11111111-2222-3333-4444-555555555555",
"client": "company_|_username",
"server": "server_name",
"service": "UNIVERSAL",
"operation": "run_plan_calculation",
"time": "2024-02-21T09:30:00+03:00"
},
"warnings": [ ]
}

Clipping (SYNC)

Data clipping.

Authorizations:

ApiKeyAuth

path Parameters

clip_key

required

string [ 1 .. 1024 ] characters

Example: crop_key_1

Target essence key.

query Parameters

clip_strategy

string (clip_strategy)

Example: clip_strategy=CROP_WITH_TRANSIT_ELEVATORS

Data clipping strategy.

Request Body schema: application/json
required

Data for clipping.

required	Array of objects (crop) [ 1 .. 501 ] items unique List of crops.
required	Array of objects (field) [ 1 .. 20001 ] items unique List of fields.
	Array of objects (elevator) [ 1 .. 501 ] items unique List of elevators.
required	Array of objects (factory) [ 1 .. 501 ] items unique List of factories.
required	Array of objects (market) [ 1 .. 501 ] items unique List of markets.
required	Array of objects (movement_matrix) [ 1 .. 8040402 ] items unique Matrix describing the cost (in kilometers and monetary units) of moving grain between objects (in both directions). If there is no corresponding entry in the matrix between the objects, the movement of grain between them is considered impossible.
	Array of objects (leftover) [ 0 .. 25001 ] items List of leftovers.
required	object (plan_settings) Plan settings.

Responses

Response Schema: application/json

required	Array of objects (crop) [ 1 .. 501 ] items unique List of crops.
required	Array of objects (field) [ 1 .. 20001 ] items unique List of fields.
	Array of objects (elevator) [ 1 .. 501 ] items unique List of elevators.
required	Array of objects (factory) [ 1 .. 501 ] items unique List of factories.
required	Array of objects (market) [ 1 .. 501 ] items unique List of markets.
required	Array of objects (movement_matrix) [ 1 .. 8040402 ] items unique Matrix describing the cost (in kilometers and monetary units) of moving grain between objects (in both directions). If there is no corresponding entry in the matrix between the objects, the movement of grain between them is considered impossible.
	Array of objects (leftover) [ 0 .. 25001 ] items List of leftovers.
required	object (plan_settings) Plan settings.

Request samples

Payload

Content type

application/json

{"crops": [{"key": "bean",
"base_humidity": 180,
"compatible_storage_types": ["granary"
],
"compatible_silo_types": [ ],
"attributes": [{"key": "full_name",
"value": "Бобы сои"
}
]
}
],
"fields": [{"key": "field_1",
"crop_key": "bean",
"capacity_forecast": [{"date_window": {"from": "2023-01-01",
"to": "2023-01-05"
},
"capacity": 1000
}
],
"humidity_forecast": [{"date_window": {"from": "2023-01-01",
"to": "2023-01-03"
},
"humidity": 220
},
{"date_window": {"from": "2023-01-04",
"to": "2023-01-05"
},
"humidity": 170
}
],
"amount": 5000,
"attributes": [{"key": "full_number",
"value": "57-4-6-130-227"
}
]
}
],
"elevators": [{"key": "elevator_1",
"gate": {"key": "gate_1",
"input_capacity_forecast": [{"date_window": {"from": "2023-01-01",
"to": "2023-01-10"
},
"capacity": 100
}
],
"output_capacity_forecast": [{"date_window": {"from": "2023-01-01",
"to": "2023-01-10"
},
"capacity": 100
}
]
},
"dryers": [{"key": "dryer_1",
"chamber_variants": [{"crop_key": "bean",
"capacity_forecast": [{"date_window": {"from": "2023-01-01",
"to": "2023-01-10"
},
"capacity": 15000
}
],
"productivity_forecast": [{"date_window": {"from": "2023-01-01",
"to": "2023-01-10"
},
"productivity": 5000
}
]
}
]
}
],
"storages": [{"key": "storage_1",
"type": "granary",
"capacity_forecast": [{"date_window": {"from": "2023-01-01",
"to": "2023-01-05"
},
"capacity": 5000
},
{"date_window": {"from": "2023-01-06",
"to": "2023-01-10"
},
"capacity": 4100
}
]
}
],
"silos": [{"key": "silo_1",
"type": "trench",
"deployment_cost": 1888,
"capacity_forecast": [{"date_window": {"from": "2023-01-01",
"to": "2023-07-15"
},
"capacity": 50000
}
]
}
],
"attributes": [ ]
}
],
"factories": [{"key": "factory_1",
"gate": {"key": "factory_gate_1",
"input_capacity_forecast": [{"date_window": {"from": "2023-01-01",
"to": "2023-01-10"
},
"capacity": 2000
}
],
"output_capacity_forecast": [ ]
},
"dryers": [{"key": "factory_dryer_1",
"chamber_variants": [{"crop_key": "bean",
"capacity_forecast": [{"date_window": {"from": "2023-01-01",
"to": "2023-01-10"
},
"capacity": 17000
}
],
"productivity_forecast": [{"date_window": {"from": "2023-01-01",
"to": "2023-01-10"
},
"productivity": 2700
}
]
}
]
}
],
"bunkers": [{"key": "bunker_1",
"capacity_forecast": [{"date_window": {"from": "2023-01-01",
"to": "2023-01-10"
},
"capacity": 5000
}
]
}
],
"consumers": [{"key": "factory_line_1",
"crop_key": "bean",
"consumption_forecast": [{"date_window": {"from": "2023-01-05",
"to": "2023-01-11"
},
"capacity": 500
},
{"date_window": {"from": "2023-01-12",
"to": "2023-01-15"
},
"capacity": 20
}
],
"stock_forecast": [{"date_window": {"from": "2023-01-01",
"to": "2023-01-12"
},
"min_stock_days": 2
}
]
}
],
"attributes": [ ]
}
],
"markets": [{"key": "market_1",
"contracts": [{"key": "contract_1",
"type": "BUY",
"target_keys": ["elevator_1"
],
"pricelist": [{"crop_key": "bean",
"price_forecast": [{"date_window": {"from": "2023-01-01",
"to": "2023-01-15"
},
"price": 280
}
]
}
]
},
{"key": "contract_2",
"type": "SELL",
"target_keys": ["factory_1"
],
"pricelist": [{"crop_key": "bean",
"price_forecast": [{"date_window": {"from": "2023-01-01",
"to": "2023-01-15"
},
"price": 320
}
]
}
]
}
],
"attributes": [ ]
}
],
"movement_matrix": [{"source_key": "field_1",
"destination_key": "factory_1",
"distance": 100,
"cost_per_transport": 5000
},
{"source_key": "field_1",
"destination_key": "elevator_1",
"distance": 70,
"cost_per_transport": 5000
},
{"source_key": "elevator_1",
"destination_key": "factory_1",
"distance": 40,
"cost_per_transport": 5000
},
{"source_key": "elevator_1",
"destination_key": "market_1",
"distance": 5,
"cost_per_transport": 5000
},
{"source_key": "factory_1",
"destination_key": "market_1",
"distance": 5,
"cost_per_transport": 5000
}
],
"leftovers": [{"crop_key": "bean",
"humidity": 50,
"target_key": "field_1",
"target_detail_key": null,
"amount": 4990
}
],
"plan_settings": {"project_settings": {"configuration": "OPTIMIZE_DISTANCE",
"start_date": "2023-01-01",
"end_date": "2023-01-15",
"transport_capacity": 23
},
"calculation_settings": {"result_ttl": "PT20M",
"treat_warnings_as_errors": false
}
}
}

Response samples

Content type

application/json

{"crops": [{"key": "bean",
"base_humidity": 180,
"compatible_storage_types": ["granary"
],
"compatible_silo_types": [ ],
"attributes": [{"key": "full_name",
"value": "Бобы сои"
}
]
}
],
"fields": [{"key": "field_1",
"crop_key": "bean",
"capacity_forecast": [{"date_window": {"from": "2023-01-01",
"to": "2023-01-05"
},
"capacity": 1000
}
],
"humidity_forecast": [{"date_window": {"from": "2023-01-01",
"to": "2023-01-03"
},
"humidity": 220
},
{"date_window": {"from": "2023-01-04",
"to": "2023-01-05"
},
"humidity": 170
}
],
"amount": 5000,
"attributes": [{"key": "full_number",
"value": "57-4-6-130-227"
}
]
}
],
"elevators": [{"key": "elevator_1",
"gate": {"key": "gate_1",
"input_capacity_forecast": [{"date_window": {"from": "2023-01-01",
"to": "2023-01-10"
},
"capacity": 100
}
],
"output_capacity_forecast": [{"date_window": {"from": "2023-01-01",
"to": "2023-01-10"
},
"capacity": 100
}
]
},
"dryers": [{"key": "dryer_1",
"chamber_variants": [{"crop_key": "bean",
"capacity_forecast": [{"date_window": {"from": "2023-01-01",
"to": "2023-01-10"
},
"capacity": 15000
}
],
"productivity_forecast": [{"date_window": {"from": "2023-01-01",
"to": "2023-01-10"
},
"productivity": 5000
}
]
}
]
}
],
"storages": [{"key": "storage_1",
"type": "granary",
"capacity_forecast": [{"date_window": {"from": "2023-01-01",
"to": "2023-01-05"
},
"capacity": 5000
},
{"date_window": {"from": "2023-01-06",
"to": "2023-01-10"
},
"capacity": 4100
}
]
}
],
"silos": [{"key": "silo_1",
"type": "trench",
"deployment_cost": 1888,
"capacity_forecast": [{"date_window": {"from": "2023-01-01",
"to": "2023-07-15"
},
"capacity": 50000
}
]
}
],
"attributes": [ ]
}
],
"factories": [{"key": "factory_1",
"gate": {"key": "factory_gate_1",
"input_capacity_forecast": [{"date_window": {"from": "2023-01-01",
"to": "2023-01-10"
},
"capacity": 2000
}
],
"output_capacity_forecast": [ ]
},
"dryers": [{"key": "factory_dryer_1",
"chamber_variants": [{"crop_key": "bean",
"capacity_forecast": [{"date_window": {"from": "2023-01-01",
"to": "2023-01-10"
},
"capacity": 17000
}
],
"productivity_forecast": [{"date_window": {"from": "2023-01-01",
"to": "2023-01-10"
},
"productivity": 2700
}
]
}
]
}
],
"bunkers": [{"key": "bunker_1",
"capacity_forecast": [{"date_window": {"from": "2023-01-01",
"to": "2023-01-10"
},
"capacity": 5000
}
]
}
],
"consumers": [{"key": "factory_line_1",
"crop_key": "bean",
"consumption_forecast": [{"date_window": {"from": "2023-01-05",
"to": "2023-01-11"
},
"capacity": 500
},
{"date_window": {"from": "2023-01-12",
"to": "2023-01-15"
},
"capacity": 20
}
],
"stock_forecast": [{"date_window": {"from": "2023-01-01",
"to": "2023-01-12"
},
"min_stock_days": 2
}
]
}
],
"attributes": [ ]
}
],
"markets": [{"key": "market_1",
"contracts": [{"key": "contract_1",
"type": "BUY",
"target_keys": ["elevator_1"
],
"pricelist": [{"crop_key": "bean",
"price_forecast": [{"date_window": {"from": "2023-01-01",
"to": "2023-01-15"
},
"price": 280
}
]
}
]
},
{"key": "contract_2",
"type": "SELL",
"target_keys": ["factory_1"
],
"pricelist": [{"crop_key": "bean",
"price_forecast": [{"date_window": {"from": "2023-01-01",
"to": "2023-01-15"
},
"price": 320
}
]
}
]
}
],
"attributes": [ ]
}
],
"movement_matrix": [{"source_key": "field_1",
"destination_key": "factory_1",
"distance": 100,
"cost_per_transport": 5000
},
{"source_key": "field_1",
"destination_key": "elevator_1",
"distance": 70,
"cost_per_transport": 5000
},
{"source_key": "elevator_1",
"destination_key": "factory_1",
"distance": 40,
"cost_per_transport": 5000
},
{"source_key": "elevator_1",
"destination_key": "market_1",
"distance": 5,
"cost_per_transport": 5000
},
{"source_key": "factory_1",
"destination_key": "market_1",
"distance": 5,
"cost_per_transport": 5000
}
],
"leftovers": [{"crop_key": "bean",
"humidity": 50,
"target_key": "field_1",
"target_detail_key": null,
"amount": 4990
}
],
"plan_settings": {"project_settings": {"configuration": "OPTIMIZE_DISTANCE",
"start_date": "2023-01-01",
"end_date": "2023-01-15",
"transport_capacity": 23
},
"calculation_settings": {"result_ttl": "PT20M",
"treat_warnings_as_errors": false
}
}
}

System

系统功能。所有服务共有的辅助功能。

检查服务可用性

检查服务可用性。

Responses

Response Schema: application/json

health

required

number<double> [ 0 .. 1 ]

Current health.

Response samples

200
404
429
500

Content type

application/json

{"health": 0.999
}

获取服务版本

获取服务版本。

Responses

Response Schema: application/json

major required	integer<int32> [ 1 .. 100 ] 产品版本。在单个版本中，保证了服务之间通用数据结构的兼容性。版本更改表示与以前版本的产品（和所有服务）不兼容的更改。
minor required	integer<int32> [ 0 .. 111 ] 服务的小版本。版本更改表示新功能。该更新向后兼容服务的主要版本。
build required	string [ 1 .. 64 ] characters 构建版本。包含向后兼容的错误修复和文档更新。

Response samples

200
404
429
500

Content type

application/json

{"major": 4,
"minor": 4,
"build": "1754RC"
}

检查服务可用性

检查服务可用性。

path Parameters

filename

required

string [ 6 .. 128 ] characters

Example: file_en.html

File name.

Responses

Response Schema:
text/html

string (file_html)

File with data in HTML format.

Response samples

404
429
500

Content type

application/json

{"resource_id": "resource_id",
"detail": {"tracedata": {"code": "11111111-2222-3333-4444-555555555555",
"client": "company_|_username",
"server": "server_name",
"service": "UNIVERSAL",
"operation": "run_plan_calculation",
"time": "2024-02-21T09:30:00+03:00"
}
}
}

VRt.Agro [AG] (6.20.2289)

描述

对象概述

实体图

Plan

Planning (SYNC)

Authorizations:

Request Body schema: application/jsonrequired

Responses

Response Schema: application/json

Request samples

Response samples

Planning (ASYNC)

Authorizations:

Request Body schema: application/jsonrequired

Responses

Response Schema: application/json

Request samples

Response samples

Calculation state

Authorizations:

path Parameters

Responses

Response Schema: application/json

Response samples

Cancel calculation

Authorizations:

path Parameters

Responses

Response samples

Getting the result

Authorizations:

path Parameters

Responses

Response Schema: application/json

Response Schema: application/json

Response samples

Result removal

Authorizations:

path Parameters

Responses

Response samples

Data validation

Authorizations:

Request Body schema: application/jsonrequired

Responses

Response Schema: application/json

Request samples

Response samples

Clipping (SYNC)

Authorizations:

path Parameters

query Parameters

Request Body schema: application/jsonrequired

Responses

Response Schema: application/json

Request samples

Response samples

System

检查服务可用性

Responses

Response Schema: application/json

Response samples

获取服务版本

Responses

Response Schema: application/json

Response samples

检查服务可用性

path Parameters

Responses

Response Schema:text/htmltext/plaintext/html

Response samples

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Response Schema:
text/html