VRt.Agro [AG] (6.20.2289)

Veeroute Support Team: servicedesk@veeroute.comLicense: Proprietary

Программный интерфейс для Veeroute Agro.

Основной сайт

Описание

Сервис предназначен для расчета плана работ производственных объектов.

Общая схема

objects

Поле

производит определенную сельскохозяйственную культуру определенной влажности
продукция с поля может перемещаться только на Элеватор или Завод

Элеватор (Ток)

состоит из Ворот, Сушилок, краткосрочных и долгосрочных мест хранения
сушит зерно (если влажность культуры больше допустимой)
хранит сухое зерно в краткосрочных местах хранения (складах), при этом допускается выгрузка и загрузка зерна в рамках одних суток
хранит сухое зерно в долгосрочных местах хранения (рукавах, траншеях, курганах)
при хранении в одном хранилище может находится только один вид культуры
продает излишки зерна на Рынок
производственные процессы внутри объекта: сушка, загрузка/выгрузка в место хранения, хранение

Завод

состоит из Ворот, Сушилок, Бункеров, Потребителей
[если присутствует сушка] сушит зерно (если влажность культуры больше допустимой)
хранит сухое зерно в Бункерах (краткосрочное хранилище, привязанное к определенной культуре)
поддерживает в Бункерах минимальный запас зерна для потребления
потребляет зерно из Бункеров
закупает недостающее зерно с Рынка
производственные процессы внутри объекта: сушка, загрузка/выгрузка в место хранения, хранение, потребление

Рынок

закупает зерно у Элеваторов
продает зерно Заводам

Проект

Проект отражает запланированную последовательность операций над сельскохозяйственными культурами, ниже описаны типы операций.

HARVEST

Уборка сельскохозяйственной культуры:

между производственными объектами (Полем и Элеватором или Заводом)
операция происходит внутри одного дня
на Поле происходит определение влажности зерна

	Объект (target_key)	Подобъект (target_detail_key)
Источник (source)	Поле	-
Назначение (destination)	Элеватор или Завод	Ворота

DRY

Сушка культуры:

внутри производственного объекта (Элеватора или Завода)
длительность операции - сутки
в процессе сушки меняется масса и тип влажности (WET -> DRY)
в источнике указывается масса сырой культуры
в назначении указывается полученная масса сухой культуры

	Объект (target_key)	Подобъект (target_detail_key)
Источник (source)	Элеватор или Завод	Ворота
Назначение (destination)	Элеватор или Завод	Сушилка

LOAD

Загрузка культуры с Ворот в Место хранения (долгосрочное, краткосрочное, бункер):

между частями одного производственного объекта (Элеватора или Завода)
операция происходит внутри одного дня

	Объект (target_key)	Подобъект (target_detail_key)
Источник (source)	Элеватор или Завод	Ворота или Сушилка
Назначение (destination)	Элеватор или Завод	Место хранения (долгосрочное, краткосрочное, бункер)

UNLOAD

Выгрузка культуры из места хранения на Ворота:

между частями одного производственного объекта (Элеватора)
операция происходит внутри одного дня

	Объект (target_key)	Подобъект (target_detail_key)
Источник (source)	Элеватор	Место хранения (долгосрочное, краткосрочное, бункер) или Сушилка
Назначение (destination)	Элеватор	Ворота

STORE

Хранение культуры:

место хранения не меняется
длительность операции - сутки
операция происходит через ночь

	Объект (target_key)	Подобъект (target_detail_key)
Источник (source)	Элеватор или Завод	Место хранения (долгосрочное, краткосрочное, бункер)
Назначение (destination)	Элеватор или Завод	То же самое место хранения

RELOCATE

Перевозка между производственными объектами:

между производственными объектами (Элеватором и Заводом)
операция происходит внутри одного дня

	Объект (target_key)	Подобъект (target_detail_key)
Источник (source)	Элеватор	Ворота
Назначение (destination)	Завод	Ворота

CONSUMPTION

Потребление культуры заводом:

между частями одного производственного объекта (Завода)
операция происходит внутри одного дня
потребление идет из Бункера
дополнительно можем потреблять прямо с Ворот или Сушилки без закладки в Бункер

	Объект (target_key)	Подобъект (target_detail_key)
Источник (source)	Завод	Бункер или Ворота или Сушилка
Назначение (destination)	Завод	Потребитель

SELL

Продажа культуры:

между производственными объектами (Элеватором и Рынком)
операция происходит внутри одного дня

	Объект (target_key)	Подобъект (target_detail_key)
Источник (source)	Элеватор	Ворота
Назначение (destination)	Рынок	Контракт

BUY

Покупка культуры:

между производственными объектами (Рынком и Заводом)
операция происходит внутри одного дня

	Объект (target_key)	Подобъект (target_detail_key)
Источник (source)	Рынок	Контракт
Назначение (destination)	Завод	Ворота

Диаграмма сущностей

erd

Plan

Расчет производственного плана.

Планирование (SYNC)

Расчет оптимального производственного плана.

Authorizations:

ApiKeyAuth

Request Body schema: application/json
required

Данные для расчета.

required	Array of objects (crop) [ 1 .. 501 ] items unique Список сельскохозяйственных культур.
required	Array of objects (field) [ 1 .. 20001 ] items unique Список полей, на которых произрастают сельскохозяйственные культуры.
	Array of objects (elevator) [ 1 .. 501 ] items unique Список токов - производственных объектов по подготовке и хранению зерна.
required	Array of objects (factory) [ 1 .. 501 ] items unique Список заводов - потребителей зерна.
required	Array of objects (market) [ 1 .. 501 ] items unique Список рынков.
required	Array of objects (movement_matrix) [ 1 .. 8040402 ] items unique Матрица описывающая стоимость (в километрах и денежных единицах) перемещения зерна между объектами (в обе стороны). Если между объектами нет соответствующей записи в матрице - перемещение зерна между ними считается невозможным.
	Array of objects (leftover) [ 0 .. 25001 ] items Остатки зерна на текущий момент - в полях, хранилищах, сушилках.
required	object (plan_settings) Настройки планирования.

Responses

Response Schema: application/json

required	object (tracedata) Данные используемые для трассировки запросов.
required	Array of objects (project) [ 0 .. 1000001 ] items Производственный план. Последовательность выполнения работ.
required	object (plan_statistics) Общая статистика.
	Array of objects (entity_warning_list) [ 0 .. 100001 ] items Список предупреждений. В зависимости от флага `calculation_settings.treat_warnings_as_errors` - сработавшие проверки интерпретируются как ошибки или приводят к удалению некорректных данных из расчета.
	object (unplanned_items) Список незапланированных сущностей.
progress required	integer<int32> (calculation_progress) [ 0 .. 100 ] Прогресс расчета в процентах. Прогресс отражает текущее количество завершенных шагов.
required	object (calculation_info) Информация о расчете.

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": [ ]
}

Планирование (ASYNC)

Получение результата производится с помощью метода result, а удаление - с помощью delete.

Authorizations:

ApiKeyAuth

Request Body schema: application/json
required

Данные для расчета.

required	Array of objects (crop) [ 1 .. 501 ] items unique Список сельскохозяйственных культур.
required	Array of objects (field) [ 1 .. 20001 ] items unique Список полей, на которых произрастают сельскохозяйственные культуры.
	Array of objects (elevator) [ 1 .. 501 ] items unique Список токов - производственных объектов по подготовке и хранению зерна.
required	Array of objects (factory) [ 1 .. 501 ] items unique Список заводов - потребителей зерна.
required	Array of objects (market) [ 1 .. 501 ] items unique Список рынков.
required	Array of objects (movement_matrix) [ 1 .. 8040402 ] items unique Матрица описывающая стоимость (в километрах и денежных единицах) перемещения зерна между объектами (в обе стороны). Если между объектами нет соответствующей записи в матрице - перемещение зерна между ними считается невозможным.
	Array of objects (leftover) [ 0 .. 25001 ] items Остатки зерна на текущий момент - в полях, хранилищах, сушилках.
required	object (plan_settings) Настройки планирования.

Responses

Response Schema: application/json

required	object (tracedata) Данные используемые для трассировки запросов.
id required	string<uuid> (calculation_id) Идентификатор расчета.

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"
}

Состояние расчета

Получение состояния расчета по идентификатору расчета.

Authorizations:

ApiKeyAuth

path Parameters

id

required

string<uuid> (calculation_id)

Example: 11111111-2222-3333-4444-555555555555

Идентификатор расчета.

Responses

Response Schema: application/json

required	object (tracedata) Данные используемые для трассировки запросов.
progress required	integer<int32> (calculation_progress) [ 0 .. 100 ] Прогресс расчета в процентах. Прогресс отражает текущее количество завершенных шагов.
required	object (calculation_info) Информация о расчете.

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"
}
}

Отмена расчета

Отмена процесса планирования по идентификатору расчета.

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": [ ]
}

Получение результата

Получение результата расчета по идентификатору расчета.

Authorizations:

ApiKeyAuth

path Parameters

id

required

string<uuid> (calculation_id)

Example: 11111111-2222-3333-4444-555555555555

Идентификатор расчета.

Responses

Response Schema: application/json

required	object (tracedata) Данные используемые для трассировки запросов.
required	Array of objects (project) [ 0 .. 1000001 ] items Производственный план. Последовательность выполнения работ.
required	object (plan_statistics) Общая статистика.
	Array of objects (entity_warning_list) [ 0 .. 100001 ] items Список предупреждений. В зависимости от флага `calculation_settings.treat_warnings_as_errors` - сработавшие проверки интерпретируются как ошибки или приводят к удалению некорректных данных из расчета.
	object (unplanned_items) Список незапланированных сущностей.
progress required	integer<int32> (calculation_progress) [ 0 .. 100 ] Прогресс расчета в процентах. Прогресс отражает текущее количество завершенных шагов.
required	object (calculation_info) Информация о расчете.

Response Schema: application/json

required	object (tracedata) Данные используемые для трассировки запросов.
required	Array of objects (project) [ 0 .. 1000001 ] items Производственный план. Последовательность выполнения работ.
required	object (plan_statistics) Общая статистика.
	Array of objects (entity_warning_list) [ 0 .. 100001 ] items Список предупреждений. В зависимости от флага `calculation_settings.treat_warnings_as_errors` - сработавшие проверки интерпретируются как ошибки или приводят к удалению некорректных данных из расчета.
	object (unplanned_items) Список незапланированных сущностей.
progress required	integer<int32> (calculation_progress) [ 0 .. 100 ] Прогресс расчета в процентах. Прогресс отражает текущее количество завершенных шагов.
required	object (calculation_info) Информация о расчете.

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": [ ]
}

Удаление результата

Удаление результата по идентификатору расчета.

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": [ ]
}

Валидация данных

Проверка данных перед отправкой на расчет.

Authorizations:

ApiKeyAuth

Request Body schema: application/json
required

Данные для расчета.

required	Array of objects (crop) [ 1 .. 501 ] items unique Список сельскохозяйственных культур.
required	Array of objects (field) [ 1 .. 20001 ] items unique Список полей, на которых произрастают сельскохозяйственные культуры.
	Array of objects (elevator) [ 1 .. 501 ] items unique Список токов - производственных объектов по подготовке и хранению зерна.
required	Array of objects (factory) [ 1 .. 501 ] items unique Список заводов - потребителей зерна.
required	Array of objects (market) [ 1 .. 501 ] items unique Список рынков.
required	Array of objects (movement_matrix) [ 1 .. 8040402 ] items unique Матрица описывающая стоимость (в километрах и денежных единицах) перемещения зерна между объектами (в обе стороны). Если между объектами нет соответствующей записи в матрице - перемещение зерна между ними считается невозможным.
	Array of objects (leftover) [ 0 .. 25001 ] items Остатки зерна на текущий момент - в полях, хранилищах, сушилках.
required	object (plan_settings) Настройки планирования.

Responses

Response Schema: application/json

required	object (tracedata) Данные используемые для трассировки запросов.
required	Array of objects (entity_warning_list) [ 0 .. 100001 ] items Список предупреждений. В зависимости от флага `calculation_settings.treat_warnings_as_errors` - сработавшие проверки интерпретируются как ошибки или приводят к удалению некорректных данных из расчета.

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": [ ]
}

Обрезка (SYNC)

Получение подзадачи из полной задачи на расчет.

Authorizations:

ApiKeyAuth

path Parameters

clip_key

required

string [ 1 .. 1024 ] characters

Example: crop_key_1

Ключ целевой сущности.

query Parameters

clip_strategy

string (clip_strategy)

Example: clip_strategy=CROP_WITH_TRANSIT_ELEVATORS

Стратегия обрезки входных данных:

CROP_WITH_ALL_ELEVATORS - из target_key берется ключ культуры, отфильтровываются все объекты (поля, элеваторы, заводы и остатки), которые могут принимать участие в обработке данной культуры
CROP_WITH_TRANSIT_ELEVATORS - аналогично CROP_WITH_ALL_ELEVATORS, но остаются только те элеваторы, от которых есть путь проезда одновременно до поля и до завода

Request Body schema: application/json
required

Данные для обрезки.

required	Array of objects (crop) [ 1 .. 501 ] items unique Список сельскохозяйственных культур.
required	Array of objects (field) [ 1 .. 20001 ] items unique Список полей, на которых произрастают сельскохозяйственные культуры.
	Array of objects (elevator) [ 1 .. 501 ] items unique Список токов - производственных объектов по подготовке и хранению зерна.
required	Array of objects (factory) [ 1 .. 501 ] items unique Список заводов - потребителей зерна.
required	Array of objects (market) [ 1 .. 501 ] items unique Список рынков.
required	Array of objects (movement_matrix) [ 1 .. 8040402 ] items unique Матрица описывающая стоимость (в километрах и денежных единицах) перемещения зерна между объектами (в обе стороны). Если между объектами нет соответствующей записи в матрице - перемещение зерна между ними считается невозможным.
	Array of objects (leftover) [ 0 .. 25001 ] items Остатки зерна на текущий момент - в полях, хранилищах, сушилках.
required	object (plan_settings) Настройки планирования.

Responses

Response Schema: application/json

required	Array of objects (crop) [ 1 .. 501 ] items unique Список сельскохозяйственных культур.
required	Array of objects (field) [ 1 .. 20001 ] items unique Список полей, на которых произрастают сельскохозяйственные культуры.
	Array of objects (elevator) [ 1 .. 501 ] items unique Список токов - производственных объектов по подготовке и хранению зерна.
required	Array of objects (factory) [ 1 .. 501 ] items unique Список заводов - потребителей зерна.
required	Array of objects (market) [ 1 .. 501 ] items unique Список рынков.
required	Array of objects (movement_matrix) [ 1 .. 8040402 ] items unique Матрица описывающая стоимость (в километрах и денежных единицах) перемещения зерна между объектами (в обе стороны). Если между объектами нет соответствующей записи в матрице - перемещение зерна между ними считается невозможным.
	Array of objects (leftover) [ 0 .. 25001 ] items Остатки зерна на текущий момент - в полях, хранилищах, сушилках.
required	object (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 ]

Текущий показатель здоровья сервиса.
0 означает неготовность сервиса выполнять задачи.
1 означает полную готовность сервиса для выполнения задач.

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

Название файла.

Responses

Response Schema:
text/html

string (file_html)

Файл с данными в формате HTML.

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)

Описание

Общая схема

Поле

Элеватор (Ток)

Завод

Рынок

Проект

HARVEST

DRY

LOAD

UNLOAD

STORE

RELOCATE

CONSUMPTION

SELL

BUY

Диаграмма сущностей

Plan

Планирование (SYNC)

Authorizations:

Request Body schema: application/jsonrequired

Responses

Response Schema: application/json

Request samples

Response samples

Планирование (ASYNC)

Authorizations:

Request Body schema: application/jsonrequired

Responses

Response Schema: application/json

Request samples

Response samples

Состояние расчета

Authorizations:

path Parameters

Responses

Response Schema: application/json

Response samples

Отмена расчета

Authorizations:

path Parameters

Responses

Response samples

Получение результата

Authorizations:

path Parameters

Responses

Response Schema: application/json

Response Schema: application/json

Response samples

Удаление результата

Authorizations:

path Parameters

Responses

Response samples

Валидация данных

Authorizations:

Request Body schema: application/jsonrequired

Responses

Response Schema: application/json

Request samples

Response samples

Обрезка (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

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