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

Content type
application/json
{
  • "crops": [
    ],
  • "fields": [
    ],
  • "elevators": [
    ],
  • "factories": [
    ],
  • "markets": [
    ],
  • "movement_matrix": [
    ],
  • "leftovers": [
    ],
  • "plan_settings": {
    }
}

Response samples

Content type
application/json
{
  • "tracedata": {
    },
  • "project": [
    ],
  • "statistics": {
    },
  • "progress": 100,
  • "info": {
    },
  • "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

Content type
application/json
{
  • "crops": [
    ],
  • "fields": [
    ],
  • "elevators": [
    ],
  • "factories": [
    ],
  • "markets": [
    ],
  • "movement_matrix": [
    ],
  • "leftovers": [
    ],
  • "plan_settings": {
    }
}

Response samples

Content type
application/json
{
  • "tracedata": {
    },
  • "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": {
    },
  • "progress": 52,
  • "info": {
    }
}

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": {
    },
  • "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": {
    },
  • "project": [
    ],
  • "statistics": {
    },
  • "progress": 100,
  • "info": {
    },
  • "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": {
    },
  • "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

Content type
application/json
{
  • "crops": [
    ],
  • "fields": [
    ],
  • "elevators": [
    ],
  • "factories": [
    ],
  • "markets": [
    ],
  • "movement_matrix": [
    ],
  • "leftovers": [
    ],
  • "plan_settings": {
    }
}

Response samples

Content type
application/json
{
  • "tracedata": {
    },
  • "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

Content type
application/json
{
  • "crops": [
    ],
  • "fields": [
    ],
  • "elevators": [
    ],
  • "factories": [
    ],
  • "markets": [
    ],
  • "movement_matrix": [
    ],
  • "leftovers": [
    ],
  • "plan_settings": {
    }
}

Response samples

Content type
application/json
{
  • "crops": [
    ],
  • "fields": [
    ],
  • "elevators": [
    ],
  • "factories": [
    ],
  • "markets": [
    ],
  • "movement_matrix": [
    ],
  • "leftovers": [
    ],
  • "plan_settings": {
    }
}

System

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

检查服务可用性

检查服务可用性。

Responses

Response Schema: application/json
health
required
number<double> [ 0 .. 1 ]

Current health.

Response samples

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

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:
string (file_html)

File with data in HTML format.

Response samples

Content type
application/json
{
  • "resource_id": "resource_id",
  • "detail": {
    }
}