VRt.Studio
VEEROUTE 2024

VRt.Studio [ST] (6.20.2289)

Veeroute Support Team: servicedesk@veeroute.comLicense: Proprietary Terms of Service

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

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

Описание

Серверная часть Veeroute Studio.

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

erd

Explorer

Управление структурой папок.

Создание папки

Создание новой папки.

Authorizations:
ApiKeyAuth
Request Body schema: application/json
required

Запрос на создание папки.

parent_key
required
string<uuid> (unique_key)

Ключ папки, в которой будет создана новая папка.

name
required
string [ 1 .. 100 ] characters

Название новой папки.

Responses

Request samples

Content type
application/json
{
  • "parent_key": "11111111-2222-3333-4444-555555555555",
  • "name": "folder_1_new"
}

Response samples

Content type
application/json
"11111111-2222-3333-4444-555555555555"

Чтение структуры папок

Получение структуры папок.

Authorizations:
ApiKeyAuth

Responses

Response Schema: application/json
key
required
string<uuid> (unique_key)

Ключ, уникальный идентификатор.

type
required
string (folder_type)
Enum: "ROOT" "FOLDER"

Тип элемента:

  • ROOT - корневой объект
  • FOLDER - папка
name
required
string [ 1 .. 100 ] characters

Название папки.

required
object (folder_stats)

Стастика по текущей папке.

elements
Array of objects (filesystem) [ 0 .. 101 ] items

Список дочерних элементов.

Response samples

Content type
application/json
{
  • "key": "5fffc47c-8239-42c4-8a3f-95d0ed235173",
  • "type": "ROOT",
  • "name": "ROOT",
  • "statistics": {
    },
  • "elements": [
    ]
}

Список экспериментов

Получение списка экспериментов.

Authorizations:
ApiKeyAuth
path Parameters
folder_key
required
string<uuid> (unique_key)
Example: 11111111-2222-3333-4444-555555555555

Ключ папки, уникальный идентификатор.

query Parameters
filter
string [ 1 .. 64 ] characters
Example: filter=example text

Фильтр для поиска по текстовым полям - возвращаются только те эксперименты, у которых в названии или описании содержится подстрока из фильтра. Если фильтр пустой - возвращаются все эксперименты в папке.

Responses

Response Schema: application/json
required
Array of objects (experiment) [ 0 .. 101 ] items

Список экспериментов.

required
object (table_list_stats)

Статистика по списку.

Response samples

Content type
application/json
{
  • "experiments": [
    ],
  • "statistics": {
    }
}

Обновление папки

Переименование \ перемещение папки.

Authorizations:
ApiKeyAuth
path Parameters
folder_key
required
string<uuid> (unique_key)
Example: 11111111-2222-3333-4444-555555555555

Ключ папки, уникальный идентификатор.

Request Body schema: application/json
required

Запрос на обновление папки.

parent_key
required
string<uuid> (unique_key)

Ключ папки, в которой будет создана новая папка.

name
required
string [ 1 .. 100 ] characters

Название новой папки.

Responses

Response Schema: application/json
key
required
string<uuid> (unique_key)

Ключ, уникальный идентификатор.

type
required
string (folder_type)
Enum: "ROOT" "FOLDER"

Тип элемента:

  • ROOT - корневой объект
  • FOLDER - папка
name
required
string [ 1 .. 100 ] characters

Название папки.

required
object (folder_stats)

Стастика по текущей папке.

elements
Array of objects (filesystem) [ 0 .. 101 ] items

Список дочерних элементов.

Request samples

Content type
application/json
{
  • "parent_key": "11111111-2222-3333-4444-555555555555",
  • "name": "folder_1_new"
}

Response samples

Content type
application/json
{
  • "key": "5fffc47c-8239-42c4-8a3f-95d0ed235173",
  • "type": "ROOT",
  • "name": "ROOT",
  • "statistics": {
    },
  • "elements": [
    ]
}

Удаление папки

Удаление папки по ключу.

Authorizations:
ApiKeyAuth
path Parameters
folder_key
required
string<uuid> (unique_key)
Example: 11111111-2222-3333-4444-555555555555

Ключ папки, уникальный идентификатор.

Responses

Response samples

Content type
application/json
{
  • "tracedata": {
    },
  • "message": "logical",
  • "schema_errors": [ ],
  • "logical_errors": [
    ],
  • "warnings": [ ]
}

Experiments

Управление экспериментами

Создание эксперимента

Создание нового эксперимента.

Authorizations:
ApiKeyAuth
Request Body schema: application/json
required

Запрос на создание эксперимента.

name
required
string [ 1 .. 100 ] characters

Название эксперимента.

comment
required
string or null [ 0 .. 10000 ] characters
Default: null

Комментарий к эксперименту.

folder_key
required
string<uuid> (unique_key)

Ключ папки типа FOLDER, в которой находится эксперимент.

Responses

Request samples

Content type
application/json
{
  • "name": "Exp_1",
  • "comment": "long long long long text",
  • "folder_key": "11111111-2222-3333-4444-555555555555"
}

Response samples

Content type
application/json
"11111111-2222-3333-4444-555555555555"

Чтение эксперимента

Получение информации об эксперименте по его ключу.

Authorizations:
ApiKeyAuth
path Parameters
experiment_key
required
string<uuid> (unique_key)
Example: 11111111-2222-3333-4444-555555555555

Ключ, уникальный идентификатор.

Responses

Response Schema: application/json
key
required
string<uuid> (unique_key)

Ключ, уникальный идентификатор.

required
object (experiment_specification)

Описание эксперимента.

required
object (experiment_settings)

Настройки эксперимента.

required
object (experiment_statistics)

Статистика эксперимента.

progress
integer<int32> (calculation_progress) [ 0 .. 100 ]

Прогресс расчета в процентах, отражает текущее количество завершенных шагов. Прогресс расчета эксперимента отличается от прогресса планирования, так как имеет большее количество шагов.

object or null (experiment_calculation)

Информация по расчету эксперимента.

object or null (experiment_check)

Результат проверки данных по эксперименту.

pristine
required
boolean (basic_pristine)

Флаг, показывающий производились ли изменения сущности относительно исходных данных. true - означает что данные исходные и не изменялись.

sharing
boolean (basic_sharing)

Флаг совместного использования эксперимента.

edit_date
required
string<date-time>

Дата и время последнего редактирования в соответствии с ISO 8601.

creation_date
required
string<date-time>

Дата и время создания в соответствии с ISO 8601.

Response samples

Content type
application/json
{
  • "key": "da4e62b0-86cb-4423-b187-5c1a633ca703",
  • "specification": {
    },
  • "settings": {
    },
  • "statistics": {
    },
  • "pristine": true,
  • "edit_date": "2024-02-15T13:56:07.728Z",
  • "creation_date": "2024-02-15T13:56:07.728Z",
  • "progress": 0,
  • "sharing": false
}

Обновление эксперимента

Переименование \ перемещение эксперимента.

Authorizations:
ApiKeyAuth
path Parameters
experiment_key
required
string<uuid> (unique_key)
Example: 11111111-2222-3333-4444-555555555555

Ключ, уникальный идентификатор.

Request Body schema: application/json
required

Запрос на обновление описания эксперимента.

name
required
string [ 1 .. 100 ] characters

Название эксперимента.

comment
required
string or null [ 0 .. 10000 ] characters
Default: null

Комментарий к эксперименту.

folder_key
required
string<uuid> (unique_key)

Ключ папки типа FOLDER, в которой находится эксперимент.

Responses

Response Schema: application/json
key
required
string<uuid> (unique_key)

Ключ, уникальный идентификатор.

required
object (experiment_specification)

Описание эксперимента.

required
object (experiment_settings)

Настройки эксперимента.

required
object (experiment_statistics)

Статистика эксперимента.

progress
integer<int32> (calculation_progress) [ 0 .. 100 ]

Прогресс расчета в процентах, отражает текущее количество завершенных шагов. Прогресс расчета эксперимента отличается от прогресса планирования, так как имеет большее количество шагов.

object or null (experiment_calculation)

Информация по расчету эксперимента.

object or null (experiment_check)

Результат проверки данных по эксперименту.

pristine
required
boolean (basic_pristine)

Флаг, показывающий производились ли изменения сущности относительно исходных данных. true - означает что данные исходные и не изменялись.

sharing
boolean (basic_sharing)

Флаг совместного использования эксперимента.

edit_date
required
string<date-time>

Дата и время последнего редактирования в соответствии с ISO 8601.

creation_date
required
string<date-time>

Дата и время создания в соответствии с ISO 8601.

Request samples

Content type
application/json
{
  • "name": "Exp_1",
  • "comment": "long long long long text",
  • "folder_key": "11111111-2222-3333-4444-555555555555"
}

Response samples

Content type
application/json
{
  • "key": "11111111-2222-3333-4444-555555555555",
  • "specification": {
    },
  • "settings": {
    },
  • "statistics": {
    },
  • "progress": 52,
  • "calculation": {
    },
  • "check": {
    },
  • "pristine": false,
  • "sharing": true,
  • "edit_date": "2024-02-21T19:45:00Z",
  • "creation_date": "2024-02-21T19:45:00Z"
}

Удаление эксперимента

Удаление эксперимента по ключу.

Authorizations:
ApiKeyAuth
path Parameters
experiment_key
required
string<uuid> (unique_key)
Example: 11111111-2222-3333-4444-555555555555

Ключ, уникальный идентификатор.

Responses

Response samples

Content type
application/json
{
  • "tracedata": {
    },
  • "message": "logical",
  • "schema_errors": [ ],
  • "logical_errors": [
    ],
  • "warnings": [ ]
}

Дублирование эксперимента

Дублирование эксперимента.

Authorizations:
ApiKeyAuth
path Parameters
experiment_key
required
string<uuid> (unique_key)
Example: 11111111-2222-3333-4444-555555555555

Ключ, уникальный идентификатор.

Request Body schema: application/json
required

Запрос на дублирование эксперимента.

name
required
string [ 1 .. 100 ] characters

Название эксперимента.

comment
required
string or null [ 0 .. 10000 ] characters
Default: null

Комментарий к эксперименту.

folder_key
required
string<uuid> (unique_key)

Ключ папки типа FOLDER, в которой находится эксперимент.

Responses

Request samples

Content type
application/json
{
  • "name": "Exp_1",
  • "comment": "long long long long text",
  • "folder_key": "11111111-2222-3333-4444-555555555555"
}

Response samples

Content type
application/json
"11111111-2222-3333-4444-555555555555"

Обновление настроек

Обновление настроек.

Authorizations:
ApiKeyAuth
path Parameters
experiment_key
required
string<uuid> (unique_key)
Example: 11111111-2222-3333-4444-555555555555

Ключ, уникальный идентификатор.

Request Body schema: application/json
required

Запрос на обновление настроек эксперимента.

required
object (plan_settings)

Настройки планирования.

required
object (replan_settings)

Настройки перепланирования.

required
object (actualize_settings)

Настройки актуализации.

Responses

Response Schema: application/json
key
required
string<uuid> (unique_key)

Ключ, уникальный идентификатор.

required
object (experiment_specification)

Описание эксперимента.

required
object (experiment_settings)

Настройки эксперимента.

required
object (experiment_statistics)

Статистика эксперимента.

progress
integer<int32> (calculation_progress) [ 0 .. 100 ]

Прогресс расчета в процентах, отражает текущее количество завершенных шагов. Прогресс расчета эксперимента отличается от прогресса планирования, так как имеет большее количество шагов.

object or null (experiment_calculation)

Информация по расчету эксперимента.

object or null (experiment_check)

Результат проверки данных по эксперименту.

pristine
required
boolean (basic_pristine)

Флаг, показывающий производились ли изменения сущности относительно исходных данных. true - означает что данные исходные и не изменялись.

sharing
boolean (basic_sharing)

Флаг совместного использования эксперимента.

edit_date
required
string<date-time>

Дата и время последнего редактирования в соответствии с ISO 8601.

creation_date
required
string<date-time>

Дата и время создания в соответствии с ISO 8601.

Request samples

Content type
application/json
{
  • "plan_settings": {
    },
  • "replan_settings": {
    },
  • "actualize_settings": {
    }
}

Response samples

Content type
application/json
{
  • "key": "11111111-2222-3333-4444-555555555555",
  • "specification": {
    },
  • "settings": {
    },
  • "statistics": {
    },
  • "progress": 52,
  • "calculation": {
    },
  • "check": {
    },
  • "pristine": false,
  • "sharing": true,
  • "edit_date": "2024-02-21T19:45:00Z",
  • "creation_date": "2024-02-21T19:45:00Z"
}

Обновление индикаторов

Обновление индикаторов.

Authorizations:
ApiKeyAuth
path Parameters
experiment_key
required
string<uuid> (unique_key)
Example: 11111111-2222-3333-4444-555555555555

Ключ, уникальный идентификатор.

Request Body schema: application/json
required

Запрос на обновление индикаторов эксперимента.

Array ([ 0 .. 100 ] items)
string [ 2 .. 256 ] characters

Ключ индикатора.

Responses

Response Schema: application/json
key
required
string<uuid> (unique_key)

Ключ, уникальный идентификатор.

required
object (experiment_specification)

Описание эксперимента.

required
object (experiment_settings)

Настройки эксперимента.

required
object (experiment_statistics)

Статистика эксперимента.

progress
integer<int32> (calculation_progress) [ 0 .. 100 ]

Прогресс расчета в процентах, отражает текущее количество завершенных шагов. Прогресс расчета эксперимента отличается от прогресса планирования, так как имеет большее количество шагов.

object or null (experiment_calculation)

Информация по расчету эксперимента.

object or null (experiment_check)

Результат проверки данных по эксперименту.

pristine
required
boolean (basic_pristine)

Флаг, показывающий производились ли изменения сущности относительно исходных данных. true - означает что данные исходные и не изменялись.

sharing
boolean (basic_sharing)

Флаг совместного использования эксперимента.

edit_date
required
string<date-time>

Дата и время последнего редактирования в соответствии с ISO 8601.

creation_date
required
string<date-time>

Дата и время создания в соответствии с ISO 8601.

Request samples

Content type
application/json
[
  • "total_statistics_cost",
  • "total_statistics_measurements_waiting_time"
]

Response samples

Content type
application/json
{
  • "key": "11111111-2222-3333-4444-555555555555",
  • "specification": {
    },
  • "settings": {
    },
  • "statistics": {
    },
  • "progress": 52,
  • "calculation": {
    },
  • "check": {
    },
  • "pristine": false,
  • "sharing": true,
  • "edit_date": "2024-02-21T19:45:00Z",
  • "creation_date": "2024-02-21T19:45:00Z"
}

Запуск расчета

Запуск расчета эксперимента.

Authorizations:
ApiKeyAuth
path Parameters
experiment_key
required
string<uuid> (unique_key)
Example: 11111111-2222-3333-4444-555555555555

Ключ, уникальный идентификатор.

process_name
required
string (basic_process)
Default: "PLAN"
Enum: "PLAN" "REPLAN" "ACTUALIZE"
Example: ACTUALIZE

Название процесса обработки данных:

  • PLAN - планирование
  • REPLAN - перепланирование
  • ACTUALIZE - актуализация

Responses

Response Schema: application/json
key
required
string<uuid> (unique_key)

Ключ, уникальный идентификатор.

required
object (experiment_specification)

Описание эксперимента.

required
object (experiment_settings)

Настройки эксперимента.

required
object (experiment_statistics)

Статистика эксперимента.

progress
integer<int32> (calculation_progress) [ 0 .. 100 ]

Прогресс расчета в процентах, отражает текущее количество завершенных шагов. Прогресс расчета эксперимента отличается от прогресса планирования, так как имеет большее количество шагов.

object or null (experiment_calculation)

Информация по расчету эксперимента.

object or null (experiment_check)

Результат проверки данных по эксперименту.

pristine
required
boolean (basic_pristine)

Флаг, показывающий производились ли изменения сущности относительно исходных данных. true - означает что данные исходные и не изменялись.

sharing
boolean (basic_sharing)

Флаг совместного использования эксперимента.

edit_date
required
string<date-time>

Дата и время последнего редактирования в соответствии с ISO 8601.

creation_date
required
string<date-time>

Дата и время создания в соответствии с ISO 8601.

Response samples

Content type
application/json
{
  • "key": "da4e62b0-86cb-4423-b187-5c1a633ca703",
  • "specification": {
    },
  • "settings": {
    },
  • "statistics": {
    },
  • "pristine": true,
  • "edit_date": "2024-02-15T13:56:07.728Z",
  • "creation_date": "2024-02-15T13:56:07.728Z",
  • "progress": 0,
  • "sharing": false
}

Остановка расчета

Остановка расчета.

Authorizations:
ApiKeyAuth
path Parameters
experiment_key
required
string<uuid> (unique_key)
Example: 11111111-2222-3333-4444-555555555555

Ключ, уникальный идентификатор.

Responses

Response samples

Content type
application/json
{
  • "tracedata": {
    },
  • "message": "logical",
  • "schema_errors": [ ],
  • "logical_errors": [
    ],
  • "warnings": [ ]
}

Запуск валидации

Запуск валидации данных эксперимента.

Authorizations:
ApiKeyAuth
path Parameters
experiment_key
required
string<uuid> (unique_key)
Example: 11111111-2222-3333-4444-555555555555

Ключ, уникальный идентификатор.

process_name
required
string (basic_process)
Default: "PLAN"
Enum: "PLAN" "REPLAN" "ACTUALIZE"
Example: ACTUALIZE

Название процесса обработки данных:

  • PLAN - планирование
  • REPLAN - перепланирование
  • ACTUALIZE - актуализация

Responses

Response Schema: application/json
key
required
string<uuid> (unique_key)

Ключ, уникальный идентификатор.

required
object (experiment_specification)

Описание эксперимента.

required
object (experiment_settings)

Настройки эксперимента.

required
object (experiment_statistics)

Статистика эксперимента.

progress
integer<int32> (calculation_progress) [ 0 .. 100 ]

Прогресс расчета в процентах, отражает текущее количество завершенных шагов. Прогресс расчета эксперимента отличается от прогресса планирования, так как имеет большее количество шагов.

object or null (experiment_calculation)

Информация по расчету эксперимента.

object or null (experiment_check)

Результат проверки данных по эксперименту.

pristine
required
boolean (basic_pristine)

Флаг, показывающий производились ли изменения сущности относительно исходных данных. true - означает что данные исходные и не изменялись.

sharing
boolean (basic_sharing)

Флаг совместного использования эксперимента.

edit_date
required
string<date-time>

Дата и время последнего редактирования в соответствии с ISO 8601.

creation_date
required
string<date-time>

Дата и время создания в соответствии с ISO 8601.

Response samples

Content type
application/json
{
  • "key": "da4e62b0-86cb-4423-b187-5c1a633ca703",
  • "specification": {
    },
  • "settings": {
    },
  • "statistics": {
    },
  • "pristine": true,
  • "edit_date": "2024-02-15T13:56:07.728Z",
  • "creation_date": "2024-02-15T13:56:07.728Z",
  • "progress": 0,
  • "sharing": false
}

Импорт (XLSX)

Импорт новых данных из файла формата XLSX. Если сущность уже присутствует в эксперименте (определяется по ее ключу) - она обновляется, если нет - создается новая.

Authorizations:
ApiKeyAuth
path Parameters
experiment_key
required
string<uuid> (unique_key)
Example: 11111111-2222-3333-4444-555555555555

Ключ, уникальный идентификатор.

query Parameters
timezone
integer<int32> [ -12 .. 12 ]
Default: 0
Example: timezone=3

Временная зона.

Request Body schema: application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
required

Данные (XLSX).

string<byte> (file_xlsx)

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

Responses

Response Schema: application/json
key
required
string<uuid> (unique_key)

Ключ, уникальный идентификатор.

required
object (experiment_specification)

Описание эксперимента.

required
object (experiment_settings)

Настройки эксперимента.

required
object (experiment_statistics)

Статистика эксперимента.

progress
integer<int32> (calculation_progress) [ 0 .. 100 ]

Прогресс расчета в процентах, отражает текущее количество завершенных шагов. Прогресс расчета эксперимента отличается от прогресса планирования, так как имеет большее количество шагов.

object or null (experiment_calculation)

Информация по расчету эксперимента.

object or null (experiment_check)

Результат проверки данных по эксперименту.

pristine
required
boolean (basic_pristine)

Флаг, показывающий производились ли изменения сущности относительно исходных данных. true - означает что данные исходные и не изменялись.

sharing
boolean (basic_sharing)

Флаг совместного использования эксперимента.

edit_date
required
string<date-time>

Дата и время последнего редактирования в соответствии с ISO 8601.

creation_date
required
string<date-time>

Дата и время создания в соответствии с ISO 8601.

Response samples

Content type
application/json
{
  • "key": "11111111-2222-3333-4444-555555555555",
  • "specification": {
    },
  • "settings": {
    },
  • "statistics": {
    },
  • "progress": 52,
  • "calculation": {
    },
  • "check": {
    },
  • "pristine": false,
  • "sharing": true,
  • "edit_date": "2024-02-21T19:45:00Z",
  • "creation_date": "2024-02-21T19:45:00Z"
}

Импорт (JSON)

Импорт новых данных из файла формата VRt.Universal JSON. Если сущность уже присутствует в эксперименте (определяется по ее ключу) - она обновляется, если нет - создается новая.

Authorizations:
ApiKeyAuth
path Parameters
experiment_key
required
string<uuid> (unique_key)
Example: 11111111-2222-3333-4444-555555555555

Ключ, уникальный идентификатор.

Request Body schema: application/json
required

Данные (JSON).

Array of objects (location) [ 0 .. 15001 ] items unique

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

Array of objects (order) [ 0 .. 15001 ] items unique

Список заказов.

Array of objects (performer) [ 0 .. 15001 ] items unique

Список доступных исполнителей.

Array of objects (transport) [ 0 .. 15001 ] items unique

Список доступного транспорта.

Array of objects (hardlink) [ 0 .. 15001 ] items unique

Список назначений.

Array of objects (trip) [ 0 .. 15001 ] items unique

Существующие рейсы.

object (facts)

Произошедшие события.

object or null (plan_statistics)

Общая статистика по запланированным рейсам.

Array of objects (routing_transport_matrix_list) [ 0 .. 12 ] items unique

Список матриц времен и расстояний для каждого типа транспорта, которые указаны в данных. Матрица должна описывать все локации для каждого типа транспорта из данных. При указании внешней матрицы маршрутизации external_routing не учитываются параметры geo_settings.

object (plan_settings)

Настройки планирования.

object (replan_settings)

Настройки перепланирования.

object (actualize_settings)

Настройки актуализации.

dataset_name
string (dataset_name) [ 0 .. 1000 ] characters

Название датасета. Техническое поле, не влияющее на планирование.

Responses

Response Schema: application/json
key
required
string<uuid> (unique_key)

Ключ, уникальный идентификатор.

required
object (experiment_specification)

Описание эксперимента.

required
object (experiment_settings)

Настройки эксперимента.

required
object (experiment_statistics)

Статистика эксперимента.

progress
integer<int32> (calculation_progress) [ 0 .. 100 ]

Прогресс расчета в процентах, отражает текущее количество завершенных шагов. Прогресс расчета эксперимента отличается от прогресса планирования, так как имеет большее количество шагов.

object or null (experiment_calculation)

Информация по расчету эксперимента.

object or null (experiment_check)

Результат проверки данных по эксперименту.

pristine
required
boolean (basic_pristine)

Флаг, показывающий производились ли изменения сущности относительно исходных данных. true - означает что данные исходные и не изменялись.

sharing
boolean (basic_sharing)

Флаг совместного использования эксперимента.

edit_date
required
string<date-time>

Дата и время последнего редактирования в соответствии с ISO 8601.

creation_date
required
string<date-time>

Дата и время создания в соответствии с ISO 8601.

Request samples

Content type
application/json
{
  • "locations": [
    ],
  • "orders": [
    ],
  • "performers": [
    ],
  • "transports": [
    ],
  • "hardlinks": [
    ],
  • "trips": [
    ],
  • "facts": {
    },
  • "statistics": {
    },
  • "external_routing": [ ],
  • "plan_settings": {
    },
  • "replan_settings": {
    },
  • "actualize_settings": {
    },
  • "dataset_name": "custom_dataset_one"
}

Response samples

Content type
application/json
{
  • "key": "11111111-2222-3333-4444-555555555555",
  • "specification": {
    },
  • "settings": {
    },
  • "statistics": {
    },
  • "progress": 52,
  • "calculation": {
    },
  • "check": {
    },
  • "pristine": false,
  • "sharing": true,
  • "edit_date": "2024-02-21T19:45:00Z",
  • "creation_date": "2024-02-21T19:45:00Z"
}

Импорт по URL (JSON)

Импорт новых данных из файла формата VRt.Universal JSON по ссылке. Если сущность уже присутствует в эксперименте (определяется по ее ключу) - она обновляется, если нет - создается новая.

Authorizations:
ApiKeyAuth
path Parameters
experiment_key
required
string<uuid> (unique_key)
Example: 11111111-2222-3333-4444-555555555555

Ключ, уникальный идентификатор.

query Parameters
url
required
string<uri>
Example: url=https://docs.edge.veeroute.tech/assets/files/case_1.json

Url json файла.

Responses

Response Schema: application/json
key
required
string<uuid> (unique_key)

Ключ, уникальный идентификатор.

required
object (experiment_specification)

Описание эксперимента.

required
object (experiment_settings)

Настройки эксперимента.

required
object (experiment_statistics)

Статистика эксперимента.

progress
integer<int32> (calculation_progress) [ 0 .. 100 ]

Прогресс расчета в процентах, отражает текущее количество завершенных шагов. Прогресс расчета эксперимента отличается от прогресса планирования, так как имеет большее количество шагов.

object or null (experiment_calculation)

Информация по расчету эксперимента.

object or null (experiment_check)

Результат проверки данных по эксперименту.

pristine
required
boolean (basic_pristine)

Флаг, показывающий производились ли изменения сущности относительно исходных данных. true - означает что данные исходные и не изменялись.

sharing
boolean (basic_sharing)

Флаг совместного использования эксперимента.

edit_date
required
string<date-time>

Дата и время последнего редактирования в соответствии с ISO 8601.

creation_date
required
string<date-time>

Дата и время создания в соответствии с ISO 8601.

Response samples

Content type
application/json
{
  • "key": "11111111-2222-3333-4444-555555555555",
  • "specification": {
    },
  • "settings": {
    },
  • "statistics": {
    },
  • "progress": 52,
  • "calculation": {
    },
  • "check": {
    },
  • "pristine": false,
  • "sharing": true,
  • "edit_date": "2024-02-21T19:45:00Z",
  • "creation_date": "2024-02-21T19:45:00Z"
}

Импорт по tracecode

Импорт новых данных из файла формата VRt.Universal JSON по tracecode. Если сущность уже присутствует в эксперименте (определяется по ее ключу) - она обновляется, если нет - создается новая.

Authorizations:
ApiKeyAuth
path Parameters
experiment_key
required
string<uuid> (unique_key)
Example: 11111111-2222-3333-4444-555555555555

Ключ, уникальный идентификатор.

source
required
string (import_source)
Enum: "ACCOUNT" "ADMIN"
Example: ACCOUNT

Источник.

tracecode
required
string<uuid>
Example: 11111111-2222-3333-4444-555555555555

Уникальный идентификатор процесса.

sample
required
string (import_sample)
Enum: "TASK" "FULL"
Example: TASK

Выборка загружаемых данных - входная задача или входная задача + результат расчета.

Responses

Response Schema: application/json
key
required
string<uuid> (unique_key)

Ключ, уникальный идентификатор.

required
object (experiment_specification)

Описание эксперимента.

required
object (experiment_settings)

Настройки эксперимента.

required
object (experiment_statistics)

Статистика эксперимента.

progress
integer<int32> (calculation_progress) [ 0 .. 100 ]

Прогресс расчета в процентах, отражает текущее количество завершенных шагов. Прогресс расчета эксперимента отличается от прогресса планирования, так как имеет большее количество шагов.

object or null (experiment_calculation)

Информация по расчету эксперимента.

object or null (experiment_check)

Результат проверки данных по эксперименту.

pristine
required
boolean (basic_pristine)

Флаг, показывающий производились ли изменения сущности относительно исходных данных. true - означает что данные исходные и не изменялись.

sharing
boolean (basic_sharing)

Флаг совместного использования эксперимента.

edit_date
required
string<date-time>

Дата и время последнего редактирования в соответствии с ISO 8601.

creation_date
required
string<date-time>

Дата и время создания в соответствии с ISO 8601.

Response samples

Content type
application/json
{
  • "key": "11111111-2222-3333-4444-555555555555",
  • "specification": {
    },
  • "settings": {
    },
  • "statistics": {
    },
  • "progress": 52,
  • "calculation": {
    },
  • "check": {
    },
  • "pristine": false,
  • "sharing": true,
  • "edit_date": "2024-02-21T19:45:00Z",
  • "creation_date": "2024-02-21T19:45:00Z"
}

Экспорт (XLSX)

Экспортировать (XLSX).

Authorizations:
ApiKeyAuth
path Parameters
experiment_key
required
string<uuid> (unique_key)
Example: 11111111-2222-3333-4444-555555555555

Ключ, уникальный идентификатор.

query Parameters
timezone
integer<int32> [ -12 .. 12 ]
Default: 0
Example: timezone=3

Временная зона.

Responses

Response Schema: application/octet-stream
string<byte> (file_xlsx)

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

Response samples

Content type
application/json
{
  • "tracedata": {
    },
  • "message": "logical",
  • "schema_errors": [ ],
  • "logical_errors": [
    ],
  • "warnings": [ ]
}

Экспорт (JSON)

Экспортировать данные из эксперимента в файл формата VRt.Universal JSON.

Authorizations:
ApiKeyAuth
path Parameters
experiment_key
required
string<uuid> (unique_key)
Example: 11111111-2222-3333-4444-555555555555

Ключ, уникальный идентификатор.

Responses

Response Schema: application/json
Array of objects (location) [ 0 .. 15001 ] items unique

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

Array of objects (order) [ 0 .. 15001 ] items unique

Список заказов.

Array of objects (performer) [ 0 .. 15001 ] items unique

Список доступных исполнителей.

Array of objects (transport) [ 0 .. 15001 ] items unique

Список доступного транспорта.

Array of objects (hardlink) [ 0 .. 15001 ] items unique

Список назначений.

Array of objects (trip) [ 0 .. 15001 ] items unique

Существующие рейсы.

object (facts)

Произошедшие события.

object or null (plan_statistics)

Общая статистика по запланированным рейсам.

Array of objects (routing_transport_matrix_list) [ 0 .. 12 ] items unique

Список матриц времен и расстояний для каждого типа транспорта, которые указаны в данных. Матрица должна описывать все локации для каждого типа транспорта из данных. При указании внешней матрицы маршрутизации external_routing не учитываются параметры geo_settings.

object (plan_settings)

Настройки планирования.

object (replan_settings)

Настройки перепланирования.

object (actualize_settings)

Настройки актуализации.

dataset_name
string (dataset_name) [ 0 .. 1000 ] characters

Название датасета. Техническое поле, не влияющее на планирование.

Response samples

Content type
application/json
{
  • "locations": [
    ],
  • "orders": [
    ],
  • "performers": [
    ],
  • "transports": [
    ],
  • "hardlinks": [
    ],
  • "trips": [
    ],
  • "facts": {
    },
  • "statistics": {
    },
  • "external_routing": [ ],
  • "plan_settings": {
    },
  • "replan_settings": {
    },
  • "actualize_settings": {
    },
  • "dataset_name": "custom_dataset_one"
}

System

Системные функции. Вспомогательный функционал, общий для всех сервисов.

Проверка доступности

Проверка доступности сервиса.

Responses

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

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

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

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

Responses

Response Schema:
string (file_html)

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

Response samples

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

Locations

Управление локациями.

Список локаций

Получение списка локаций.

Authorizations:
ApiKeyAuth
path Parameters
experiment_key
required
string<uuid> (unique_key)
Example: 11111111-2222-3333-4444-555555555555

Ключ, уникальный идентификатор.

query Parameters
offset
integer<int32> [ 0 .. 10000000 ]
Default: 0
Example: offset=10

Количество пропущенных сущностей до возвращаемого списка.

limit
integer<int32> [ 1 .. 10000000 ]
Default: 100
Example: limit=10

Максимальное количество возвращаемых сущностей.

sort_field
string (table_location_column_type)
Enum: "ESSENCE_KEY" "ENABLED" "PRISTINE" … 2 more
Example: sort_field=ESSENCE_KEY

Название колонки в таблице с локациями.

sort_direction
string
Default: "ASC"
Enum: "ASC" "DESC"
Example: sort_direction=DESC

Направление сортировки.

Request Body schema: application/json
optional

Фильтр локаций.

Array of objects (table_location_filter) [ 0 .. 100 ] items

Список фильтров.

Responses

Response Schema: application/json
required
Array of objects (table_location) [ 0 .. 15001 ] items

Список.

required
object (table_list_stats)

Статистика по списку.

Request samples

Content type
application/json
{
  • "filters": [
    ]
}

Response samples

Content type
application/json
{
  • "essences": [
    ],
  • "statistics": {
    }
}

Создание локации

Создание локации.

Authorizations:
ApiKeyAuth
path Parameters
experiment_key
required
string<uuid> (unique_key)
Example: 11111111-2222-3333-4444-555555555555

Ключ, уникальный идентификатор.

Request Body schema: application/json
required

Запрос на создание нового локации.

required
object (location)

Локация - уникальное географическое местоположение объекта с параметрами доступности.

Array of objects (linked_essence_list) [ 0 .. 15001 ] items

Список связанных сущностей.

Responses

Request samples

Content type
application/json
{
  • "location": {
    },
  • "linked_essences": [
    ]
}

Response samples

Content type
application/json
{
  • "location": {
    },
  • "fields": {
    },
  • "linked_essences": [
    ]
}

Обновление локации

Обновление локации по ее ключу.

Authorizations:
ApiKeyAuth
path Parameters
experiment_key
required
string<uuid> (unique_key)
Example: 11111111-2222-3333-4444-555555555555

Ключ, уникальный идентификатор.

Request Body schema: application/json
required

Запрос на обновление локации.

required
object (location)

Локация - уникальное географическое местоположение объекта с параметрами доступности.

Array of objects (linked_essence_list) [ 0 .. 15001 ] items

Список связанных сущностей.

Responses

Response Schema: application/json
required
object (location)

Локация - уникальное географическое местоположение объекта с параметрами доступности.

object (table_location_fields)

Табличные поля локации.

Array of objects (linked_essence_list) [ 0 .. 15001 ] items

Список связанных сущностей.

Request samples

Content type
application/json
{
  • "location": {
    },
  • "linked_essences": [
    ]
}

Response samples

Content type
application/json
{
  • "location": {
    },
  • "fields": {
    },
  • "linked_essences": [
    ]
}

Чтение локации

Получение информации о локации по ее ключу.

Authorizations:
ApiKeyAuth
path Parameters
experiment_key
required
string<uuid> (unique_key)
Example: 11111111-2222-3333-4444-555555555555

Ключ, уникальный идентификатор.

essence_key
required
string or null (basic_essence_key) [ 1 .. 1024 ] characters
Default: null
Example: key01

Ключ.

Responses

Response Schema: application/json
required
object (location)

Локация - уникальное географическое местоположение объекта с параметрами доступности.

object (table_location_fields)

Табличные поля локации.

Array of objects (linked_essence_list) [ 0 .. 15001 ] items

Список связанных сущностей.

Response samples

Content type
application/json
{
  • "location": {
    },
  • "fields": {
    },
  • "linked_essences": [
    ]
}

Удаление локации

Удаление локации по ее ключу.

Authorizations:
ApiKeyAuth
path Parameters
experiment_key
required
string<uuid> (unique_key)
Example: 11111111-2222-3333-4444-555555555555

Ключ, уникальный идентификатор.

essence_key
required
string or null (basic_essence_key) [ 1 .. 1024 ] characters
Default: null
Example: key01

Ключ.

Responses

Response samples

Content type
application/json
{
  • "tracedata": {
    },
  • "message": "logical",
  • "schema_errors": [ ],
  • "logical_errors": [
    ],
  • "warnings": [ ]
}

Геоточки локаций

Получение списка геоточек.

Authorizations:
ApiKeyAuth
path Parameters
experiment_key
required
string<uuid> (unique_key)
Example: 11111111-2222-3333-4444-555555555555

Ключ, уникальный идентификатор.

query Parameters
offset
integer<int32> [ 0 .. 10000000 ]
Default: 0
Example: offset=10

Количество пропущенных сущностей до возвращаемого списка.

limit
integer<int32> [ 1 .. 10000000 ]
Default: 100
Example: limit=10

Максимальное количество возвращаемых сущностей.

Request Body schema: application/json
optional

Фильтр локаций.

Array of objects (table_location_filter) [ 0 .. 100 ] items

Список фильтров.

Responses

Response Schema: application/json
required
Array of objects (web_location_geopoint) [ 0 .. 60002 ] items

Список точек.

required
object (table_list_stats)

Статистика по списку.

Request samples

Content type
application/json
{
  • "filters": [
    ]
}

Response samples

Content type
application/json
{
  • "geopoints": [
    ],
  • "statistics": {
    }
}

Orders

Управление заказами.

Список заказов

Получение списка заказов.

Authorizations:
ApiKeyAuth
path Parameters
experiment_key
required
string<uuid> (unique_key)
Example: 11111111-2222-3333-4444-555555555555

Ключ, уникальный идентификатор.

query Parameters
offset
integer<int32> [ 0 .. 10000000 ]
Default: 0
Example: offset=10

Количество пропущенных сущностей до возвращаемого списка.

limit
integer<int32> [ 1 .. 10000000 ]
Default: 100
Example: limit=10

Максимальное количество возвращаемых сущностей.

sort_field
string (table_order_column_type)
Enum: "ESSENCE_KEY" "ENABLED" "PRISTINE" … 28 more
Example: sort_field=ESSENCE_KEY

Название колонки в таблице с заказами.

sort_direction
string
Default: "ASC"
Enum: "ASC" "DESC"
Example: sort_direction=DESC

Направление сортировки.

Request Body schema: application/json
optional

Фильтр заказов.

Array of objects (table_order_filter) [ 0 .. 100 ] items

Список фильтров.

Responses

Response Schema: application/json
required
Array of objects (table_order) [ 0 .. 15001 ] items

Список.

required
object (table_list_stats)

Статистика по списку.

Request samples

Content type
application/json
{
  • "filters": [
    ]
}

Response samples

Content type
application/json
{
  • "essences": [
    ],
  • "statistics": {
    }
}

Создание заказа

Создание заказа.

Authorizations:
ApiKeyAuth
path Parameters
experiment_key
required
string<uuid> (unique_key)
Example: 11111111-2222-3333-4444-555555555555

Ключ, уникальный идентификатор.

Request Body schema: application/json
required

Запрос на создание новой сущности.

required
object (order)

Заказ на перемещение груза, содержит список заявок.

Array of objects (linked_essence_list) [ 0 .. 15001 ] items

Список связанных сущностей.

Responses

Request samples

Content type
application/json
{
  • "order": {
    },
  • "linked_essences": [
    ]
}

Response samples

Content type
application/json
{
  • "order": {
    },
  • "fields": {
    },
  • "linked_essences": [
    ]
}

Обновление заказа

Обновление сущности по ее ключу.

Authorizations:
ApiKeyAuth
path Parameters
experiment_key
required
string<uuid> (unique_key)
Example: 11111111-2222-3333-4444-555555555555

Ключ, уникальный идентификатор.

Request Body schema: application/json
required

Запрос на обновление сущности.

required
object (order)

Заказ на перемещение груза, содержит список заявок.

Array of objects (linked_essence_list) [ 0 .. 15001 ] items

Список связанных сущностей.

Responses

Response Schema: application/json
required
object (order)

Заказ на перемещение груза, содержит список заявок.

object (table_order_fields)

Табличные поля заказа и заявок.

Array of objects (linked_essence_list) [ 0 .. 15001 ] items

Список связанных сущностей.

Request samples

Content type
application/json
{
  • "order": {
    },
  • "linked_essences": [
    ]
}

Response samples

Content type
application/json
{
  • "order": {
    },
  • "fields": {
    },
  • "linked_essences": [
    ]
}

Чтение заказа

Получение информации о заказе по его ключу.

Authorizations:
ApiKeyAuth
path Parameters
experiment_key
required
string<uuid> (unique_key)
Example: 11111111-2222-3333-4444-555555555555

Ключ, уникальный идентификатор.

essence_key
required
string or null (basic_essence_key) [ 1 .. 1024 ] characters
Default: null
Example: key01

Ключ.

Responses

Response Schema: application/json
required
object (order)

Заказ на перемещение груза, содержит список заявок.

object (table_order_fields)

Табличные поля заказа и заявок.

Array of objects (linked_essence_list) [ 0 .. 15001 ] items

Список связанных сущностей.

Response samples

Content type
application/json
{
  • "order": {
    },
  • "fields": {
    },
  • "linked_essences": [
    ]
}

Удаление заказа

Удаление заказа по его ключу.

Authorizations:
ApiKeyAuth
path Parameters
experiment_key
required
string<uuid> (unique_key)
Example: 11111111-2222-3333-4444-555555555555

Ключ, уникальный идентификатор.

essence_key
required
string or null (basic_essence_key) [ 1 .. 1024 ] characters
Default: null
Example: key01

Ключ.

Responses

Response samples

Content type
application/json
{
  • "tracedata": {
    },
  • "message": "logical",
  • "schema_errors": [ ],
  • "logical_errors": [
    ],
  • "warnings": [ ]
}

Геоточки заказов

Получение списка геоточек.

Authorizations:
ApiKeyAuth
path Parameters
experiment_key
required
string<uuid> (unique_key)
Example: 11111111-2222-3333-4444-555555555555

Ключ, уникальный идентификатор.

query Parameters
offset
integer<int32> [ 0 .. 10000000 ]
Default: 0
Example: offset=10

Количество пропущенных сущностей до возвращаемого списка.

limit
integer<int32> [ 1 .. 10000000 ]
Default: 100
Example: limit=10

Максимальное количество возвращаемых сущностей.

Request Body schema: application/json
optional

Фильтр заказов.

Array of objects (table_order_filter) [ 0 .. 100 ] items

Список фильтров.

Responses

Response Schema: application/json
required
Array of objects (web_order_geopoint) [ 0 .. 60002 ] items

Список точек.

required
object (table_list_stats)

Статистика по списку.

Request samples

Content type
application/json
{
  • "filters": [
    ]
}

Response samples

Content type
application/json
{
  • "geopoints": [
    ],
  • "statistics": {
    }
}

Включение заказов

Включение заказов в расчет.

Authorizations:
ApiKeyAuth
path Parameters
experiment_key
required
string<uuid> (unique_key)
Example: 11111111-2222-3333-4444-555555555555

Ключ, уникальный идентификатор.

Request Body schema: application/json
required

Запрос на включение заказов.

Array ([ 0 .. 15001 ] items)
string or null (basic_essence_key) [ 1 .. 1024 ] characters
Default: null

Ключ, уникальный идентификатор.

Responses

Request samples

Content type
application/json
[
  • "key01"
]

Response samples

Content type
application/json
{
  • "tracedata": {
    },
  • "message": "logical",
  • "schema_errors": [ ],
  • "logical_errors": [
    ],
  • "warnings": [ ]
}

Выключение заказов

Выключение заказов из расчета.

Authorizations:
ApiKeyAuth
path Parameters
experiment_key
required
string<uuid> (unique_key)
Example: 11111111-2222-3333-4444-555555555555

Ключ, уникальный идентификатор.

Request Body schema: application/json
required

Запрос на выключение заказов.

Array ([ 0 .. 15001 ] items)
string or null (basic_essence_key) [ 1 .. 1024 ] characters
Default: null

Ключ, уникальный идентификатор.

Responses

Request samples

Content type
application/json
[
  • "key01"
]

Response samples

Content type
application/json
{
  • "tracedata": {
    },
  • "message": "logical",
  • "schema_errors": [ ],
  • "logical_errors": [
    ],
  • "warnings": [ ]
}

Performers

Управление исполнителями.

Список исполнителей

Получение списка исполнителей.

Authorizations:
ApiKeyAuth
path Parameters
experiment_key
required
string<uuid> (unique_key)
Example: 11111111-2222-3333-4444-555555555555

Ключ, уникальный идентификатор.

query Parameters
offset
integer<int32> [ 0 .. 10000000 ]
Default: 0
Example: offset=10

Количество пропущенных сущностей до возвращаемого списка.

limit
integer<int32> [ 1 .. 10000000 ]
Default: 100
Example: limit=10

Максимальное количество возвращаемых сущностей.

sort_field
string (table_performer_column_type)
Enum: "ESSENCE_KEY" "ENABLED" "PRISTINE" … 7 more
Example: sort_field=ESSENCE_KEY

Название колонки в таблице с исполнителями.

sort_direction
string
Default: "ASC"
Enum: "ASC" "DESC"
Example: sort_direction=DESC

Направление сортировки.

Request Body schema: application/json
optional

Фильтр исполнителей.

Array of objects (table_performer_filter) [ 0 .. 100 ] items

Список фильтров.

Responses

Response Schema: application/json
required
Array of objects (table_performer) [ 0 .. 15001 ] items

Список.

required
object (table_list_stats)

Статистика по списку.

Request samples

Content type
application/json
{
  • "filters": [
    ]
}

Response samples

Content type
application/json
{
  • "essences": [
    ],
  • "statistics": {
    }
}

Создание исполнителя

Создание исполнителя.

Authorizations:
ApiKeyAuth
path Parameters
experiment_key
required
string<uuid> (unique_key)
Example: 11111111-2222-3333-4444-555555555555

Ключ, уникальный идентификатор.

Request Body schema: application/json
required

Запрос на создание нового исполнителя.

required
object (performer)

Исполнитель. Выполняет заказы, используя транспорт.

Array of objects (linked_essence_list) [ 0 .. 15001 ] items

Список связанных сущностей.

Responses

Request samples

Content type
application/json
{
  • "performer": {
    },
  • "linked_essences": [
    ]
}

Response samples

Content type
application/json
{
  • "performer": {
    },
  • "fields": {
    },
  • "linked_essences": [
    ]
}

Обновление исполнителя

Обновление исполнителя по его ключу.

Authorizations:
ApiKeyAuth
path Parameters
experiment_key
required
string<uuid> (unique_key)
Example: 11111111-2222-3333-4444-555555555555

Ключ, уникальный идентификатор.

Request Body schema: application/json
required

Запрос на обновление исполнителя.

required
object (performer)

Исполнитель. Выполняет заказы, используя транспорт.

Array of objects (linked_essence_list) [ 0 .. 15001 ] items

Список связанных сущностей.

Responses

Response Schema: application/json
required
object (performer)

Исполнитель. Выполняет заказы, используя транспорт.

object (table_performer_fields)

Табличные поля исполнителя и его смены.

Array of objects (linked_essence_list) [ 0 .. 15001 ] items

Список связанных сущностей.

Request samples

Content type
application/json
{
  • "performer": {
    },
  • "linked_essences": [
    ]
}

Response samples

Content type
application/json
{
  • "performer": {
    },
  • "fields": {
    },
  • "linked_essences": [
    ]
}

Чтение исполнителя

Получение информации об исполнителе по его ключу.

Authorizations:
ApiKeyAuth
path Parameters
experiment_key
required
string<uuid> (unique_key)
Example: 11111111-2222-3333-4444-555555555555

Ключ, уникальный идентификатор.

essence_key
required
string or null (basic_essence_key) [ 1 .. 1024 ] characters
Default: null
Example: key01

Ключ.

Responses

Response Schema: application/json
required
object (performer)

Исполнитель. Выполняет заказы, используя транспорт.

object (table_performer_fields)

Табличные поля исполнителя и его смены.

Array of objects (linked_essence_list) [ 0 .. 15001 ] items

Список связанных сущностей.

Response samples

Content type
application/json
{
  • "performer": {
    },
  • "fields": {
    },
  • "linked_essences": [
    ]
}

Удаление исполнителя

Удаление исполнителя по его ключу.

Authorizations:
ApiKeyAuth
path Parameters
experiment_key
required
string<uuid> (unique_key)
Example: 11111111-2222-3333-4444-555555555555

Ключ, уникальный идентификатор.

essence_key
required
string or null (basic_essence_key) [ 1 .. 1024 ] characters
Default: null
Example: key01

Ключ.

Responses

Response samples

Content type
application/json
{
  • "tracedata": {
    },
  • "message": "logical",
  • "schema_errors": [ ],
  • "logical_errors": [
    ],
  • "warnings": [ ]
}

Геоточки исполнителей

Получение списка геоточек.

Authorizations:
ApiKeyAuth
path Parameters
experiment_key
required
string<uuid> (unique_key)
Example: 11111111-2222-3333-4444-555555555555

Ключ, уникальный идентификатор.

query Parameters
offset
integer<int32> [ 0 .. 10000000 ]
Default: 0
Example: offset=10

Количество пропущенных сущностей до возвращаемого списка.

limit
integer<int32> [ 1 .. 10000000 ]
Default: 100
Example: limit=10

Максимальное количество возвращаемых сущностей.

Request Body schema: application/json
optional

Фильтр исполнителей.

Array of objects (table_performer_filter) [ 0 .. 100 ] items

Список фильтров.

Responses

Response Schema: application/json
required
Array of objects (web_performer_geopoint) [ 0 .. 60002 ] items

Список точек.

required
object (table_list_stats)

Статистика по списку.

Request samples

Content type
application/json
{
  • "filters": [
    ]
}

Response samples

Content type
application/json
{
  • "geopoints": [
    ],
  • "statistics": {
    }
}

Включение исполнителей

Включение исполнителей в расчет.

Authorizations:
ApiKeyAuth
path Parameters
experiment_key
required
string<uuid> (unique_key)
Example: 11111111-2222-3333-4444-555555555555

Ключ, уникальный идентификатор.

Request Body schema: application/json
required

Запрос на включение исполнителей.

Array ([ 0 .. 15001 ] items)
string or null (basic_essence_key) [ 1 .. 1024 ] characters
Default: null

Ключ, уникальный идентификатор.

Responses

Request samples

Content type
application/json
[
  • "key01"
]

Response samples

Content type
application/json
{
  • "tracedata": {
    },
  • "message": "logical",
  • "schema_errors": [ ],
  • "logical_errors": [
    ],
  • "warnings": [ ]
}

Выключение исполнителей

Выключение исполнителей из расчета.

Authorizations:
ApiKeyAuth
path Parameters
experiment_key
required
string<uuid> (unique_key)
Example: 11111111-2222-3333-4444-555555555555

Ключ, уникальный идентификатор.

Request Body schema: application/json
required

Запрос на выключение исполнителей.

Array ([ 0 .. 15001 ] items)
string or null (basic_essence_key) [ 1 .. 1024 ] characters
Default: null

Ключ, уникальный идентификатор.

Responses

Request samples

Content type
application/json
[
  • "key01"
]

Response samples

Content type
application/json
{
  • "tracedata": {
    },
  • "message": "logical",
  • "schema_errors": [ ],
  • "logical_errors": [
    ],
  • "warnings": [ ]
}

Transports

Управление транспортом.

Список транспорта

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

Authorizations:
ApiKeyAuth
path Parameters
experiment_key
required
string<uuid> (unique_key)
Example: 11111111-2222-3333-4444-555555555555

Ключ, уникальный идентификатор.

query Parameters
offset
integer<int32> [ 0 .. 10000000 ]
Default: 0
Example: offset=10

Количество пропущенных сущностей до возвращаемого списка.

limit
integer<int32> [ 1 .. 10000000 ]
Default: 100
Example: limit=10

Максимальное количество возвращаемых сущностей.

sort_field
string (table_transport_column_type)
Enum: "ESSENCE_KEY" "ENABLED" "PRISTINE" … 8 more
Example: sort_field=ESSENCE_KEY

Название колонки в таблице с транспортом.

sort_direction
string
Default: "ASC"
Enum: "ASC" "DESC"
Example: sort_direction=DESC

Направление сортировки.

Request Body schema: application/json
optional

Фильтр транспорта.

Array of objects (table_transport_filter) [ 0 .. 100 ] items

Список фильтров.

Responses

Response Schema: application/json
required
Array of objects (table_transport) [ 0 .. 15001 ] items

Список.

required
object (table_list_stats)

Статистика по списку.

Request samples

Content type
application/json
{
  • "filters": [
    ]
}

Response samples

Content type
application/json
{
  • "essences": [
    ],
  • "statistics": {
    }
}

Создание транспорта

Создание транспорта.

Authorizations:
ApiKeyAuth
path Parameters
experiment_key
required
string<uuid> (unique_key)
Example: 11111111-2222-3333-4444-555555555555

Ключ, уникальный идентификатор.

Request Body schema: application/json
required

Запрос на создание нового транспорта.

required
object (transport)

Транспорт. Исполнитель использует транспорт для перемещения и перевозки грузов.

Array of objects (linked_essence_list) [ 0 .. 15001 ] items

Список связанных сущностей.

Responses

Request samples

Content type
application/json
{
  • "transport": {
    },
  • "linked_essences": [
    ]
}

Response samples

Content type
application/json
{
  • "transport": {
    },
  • "fields": {
    },
  • "linked_essences": [
    ]
}

Обновление транспорта

Обновление транспорта по ее ключу.

Authorizations:
ApiKeyAuth
path Parameters
experiment_key
required
string<uuid> (unique_key)
Example: 11111111-2222-3333-4444-555555555555

Ключ, уникальный идентификатор.

Request Body schema: application/json
required

Запрос на обновление транспорта.

required
object (transport)

Транспорт. Исполнитель использует транспорт для перемещения и перевозки грузов.

Array of objects (linked_essence_list) [ 0 .. 15001 ] items

Список связанных сущностей.

Responses

Response Schema: application/json
required
object (transport)

Транспорт. Исполнитель использует транспорт для перемещения и перевозки грузов.

object (table_transport_fields)

Табличные поля транспорта и его смены.

Array of objects (linked_essence_list) [ 0 .. 15001 ] items

Список связанных сущностей.

Request samples

Content type
application/json
{
  • "transport": {
    },
  • "linked_essences": [
    ]
}

Response samples

Content type
application/json
{
  • "transport": {
    },
  • "fields": {
    },
  • "linked_essences": [
    ]
}

Чтение транспорта

Получение информации о транспорте по его ключу.

Authorizations:
ApiKeyAuth
path Parameters
experiment_key
required
string<uuid> (unique_key)
Example: 11111111-2222-3333-4444-555555555555

Ключ, уникальный идентификатор.

essence_key
required
string or null (basic_essence_key) [ 1 .. 1024 ] characters
Default: null
Example: key01

Ключ.

Responses

Response Schema: application/json
required
object (transport)

Транспорт. Исполнитель использует транспорт для перемещения и перевозки грузов.

object (table_transport_fields)

Табличные поля транспорта и его смены.

Array of objects (linked_essence_list) [ 0 .. 15001 ] items

Список связанных сущностей.

Response samples

Content type
application/json
{
  • "transport": {
    },
  • "fields": {
    },
  • "linked_essences": [
    ]
}

Удаление транспорта

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

Authorizations:
ApiKeyAuth
path Parameters
experiment_key
required
string<uuid> (unique_key)
Example: 11111111-2222-3333-4444-555555555555

Ключ, уникальный идентификатор.

essence_key
required
string or null (basic_essence_key) [ 1 .. 1024 ] characters
Default: null
Example: key01

Ключ.

Responses

Response samples

Content type
application/json
{
  • "tracedata": {
    },
  • "message": "logical",
  • "schema_errors": [ ],
  • "logical_errors": [
    ],
  • "warnings": [ ]
}

Геоточки транспорта

Получение списка геоточек.

Authorizations:
ApiKeyAuth
path Parameters
experiment_key
required
string<uuid> (unique_key)
Example: 11111111-2222-3333-4444-555555555555

Ключ, уникальный идентификатор.

query Parameters
offset
integer<int32> [ 0 .. 10000000 ]
Default: 0
Example: offset=10

Количество пропущенных сущностей до возвращаемого списка.

limit
integer<int32> [ 1 .. 10000000 ]
Default: 100
Example: limit=10

Максимальное количество возвращаемых сущностей.

Request Body schema: application/json
optional

Фильтр транспорта.

Array of objects (table_transport_filter) [ 0 .. 100 ] items

Список фильтров.

Responses

Response Schema: application/json
required
Array of objects (web_transport_geopoint) [ 0 .. 60002 ] items

Список точек.

required
object (table_list_stats)

Статистика по списку.

Request samples

Content type
application/json
{
  • "filters": [
    ]
}

Response samples

Content type
application/json
{
  • "geopoints": [
    ],
  • "statistics": {
    }
}

Включение транспорта

Включение транспорта в расчет.

Authorizations:
ApiKeyAuth
path Parameters
experiment_key
required
string<uuid> (unique_key)
Example: 11111111-2222-3333-4444-555555555555

Ключ, уникальный идентификатор.

Request Body schema: application/json
required

Запрос на включение транспорта.

Array ([ 0 .. 15001 ] items)
string or null (basic_essence_key) [ 1 .. 1024 ] characters
Default: null

Ключ, уникальный идентификатор.

Responses

Request samples

Content type
application/json
[
  • "key01"
]

Response samples

Content type
application/json
{
  • "tracedata": {
    },
  • "message": "logical",
  • "schema_errors": [ ],
  • "logical_errors": [
    ],
  • "warnings": [ ]
}

Выключение транспорта

Выключение транспорта из расчета.

Authorizations:
ApiKeyAuth
path Parameters
experiment_key
required
string<uuid> (unique_key)
Example: 11111111-2222-3333-4444-555555555555

Ключ, уникальный идентификатор.

Request Body schema: application/json
required

Запрос на выключение транспорта.

Array ([ 0 .. 15001 ] items)
string or null (basic_essence_key) [ 1 .. 1024 ] characters
Default: null

Ключ, уникальный идентификатор.

Responses

Request samples

Content type
application/json
[
  • "key01"
]

Response samples

Content type
application/json
{
  • "tracedata": {
    },
  • "message": "logical",
  • "schema_errors": [ ],
  • "logical_errors": [
    ],
  • "warnings": [ ]
}

Trips

Управление рейсами.

Список рейсов

Получение списка рейсов.

Authorizations:
ApiKeyAuth
path Parameters
experiment_key
required
string<uuid> (unique_key)
Example: 11111111-2222-3333-4444-555555555555

Ключ, уникальный идентификатор.

query Parameters
offset
integer<int32> [ 0 .. 10000000 ]
Default: 0
Example: offset=10

Количество пропущенных сущностей до возвращаемого списка.

limit
integer<int32> [ 1 .. 10000000 ]
Default: 100
Example: limit=10

Максимальное количество возвращаемых сущностей.

sort_field
string (table_trip_column_type)
Enum: "ESSENCE_KEY" "ENABLED" "PRISTINE" … 28 more
Example: sort_field=ESSENCE_KEY

Название колонки в таблице с рейсами.

sort_direction
string
Default: "ASC"
Enum: "ASC" "DESC"
Example: sort_direction=DESC

Направление сортировки.

Request Body schema: application/json
optional

Фильтр рейсов.

Array of objects (table_trip_filter) [ 0 .. 100 ] items

Список фильтров.

Responses

Response Schema: application/json
required
Array of objects (table_trip) [ 0 .. 15001 ] items

Список.

required
object (table_list_stats)

Статистика по списку.

Request samples

Content type
application/json
{
  • "filters": [
    ]
}

Response samples

Content type
application/json
{
  • "essences": [
    ],
  • "statistics": {
    }
}

Создание рейса

Создание рейса.

Authorizations:
ApiKeyAuth
path Parameters
experiment_key
required
string<uuid> (unique_key)
Example: 11111111-2222-3333-4444-555555555555

Ключ, уникальный идентификатор.

Request Body schema: application/json
required

Запрос на создание новой сущности.

required
object (trip)

Рейс - это совокупность работ, запланированных на выполнение конкретным исполнителем на конкретном транспорте, выраженных через изменение состояний исполнителя.

required
object (trip_statistics)

Статистика по конкретному рейсу.

Array of objects (linked_essence_list) [ 0 .. 15001 ] items

Список связанных сущностей.

Responses

Request samples

Content type
application/json
{
  • "trip": {
    },
  • "trip_statistics": {
    },
  • "linked_essences": [
    ]
}

Response samples

Content type
application/json
{
  • "trip": {
    },
  • "trip_statistics": {
    },
  • "fields": {
    },
  • "linked_essences": [
    ]
}

Обновление рейса

Обновление рейса по ее ключу.

Authorizations:
ApiKeyAuth
path Parameters
experiment_key
required
string<uuid> (unique_key)
Example: 11111111-2222-3333-4444-555555555555

Ключ, уникальный идентификатор.

Request Body schema: application/json
required

Запрос на обновление сущности.

required
object (trip)

Рейс - это совокупность работ, запланированных на выполнение конкретным исполнителем на конкретном транспорте, выраженных через изменение состояний исполнителя.

required
object (trip_statistics)

Статистика по конкретному рейсу.

Array of objects (linked_essence_list) [ 0 .. 15001 ] items

Список связанных сущностей.

Responses

Response Schema: application/json
required
object (trip)

Рейс - это совокупность работ, запланированных на выполнение конкретным исполнителем на конкретном транспорте, выраженных через изменение состояний исполнителя.

required
object (trip_statistics)

Статистика по конкретному рейсу.

object (table_trip_fields)

Табличные поля рейса и остановок.

Array of objects (linked_essence_list) [ 0 .. 15001 ] items

Список связанных сущностей.

Request samples

Content type
application/json
{
  • "trip": {
    },
  • "trip_statistics": {
    },
  • "linked_essences": [
    ]
}

Response samples

Content type
application/json
{
  • "trip": {
    },
  • "trip_statistics": {
    },
  • "fields": {
    },
  • "linked_essences": [
    ]
}

Чтение рейса

Получение информации о рейсе по его ключу.

Authorizations:
ApiKeyAuth
path Parameters
experiment_key
required
string<uuid> (unique_key)
Example: 11111111-2222-3333-4444-555555555555

Ключ, уникальный идентификатор.

essence_key
required
string or null (basic_essence_key) [ 1 .. 1024 ] characters
Default: null
Example: key01

Ключ.

Responses

Response Schema: application/json
required
object (trip)

Рейс - это совокупность работ, запланированных на выполнение конкретным исполнителем на конкретном транспорте, выраженных через изменение состояний исполнителя.

required
object (trip_statistics)

Статистика по конкретному рейсу.

object (table_trip_fields)

Табличные поля рейса и остановок.

Array of objects (linked_essence_list) [ 0 .. 15001 ] items

Список связанных сущностей.

Response samples

Content type
application/json
{
  • "trip": {
    },
  • "trip_statistics": {
    },
  • "fields": {
    },
  • "linked_essences": [
    ]
}

Удаление рейса

Удаление рейса по ключу.

Authorizations:
ApiKeyAuth
path Parameters
experiment_key
required
string<uuid> (unique_key)
Example: 11111111-2222-3333-4444-555555555555

Ключ, уникальный идентификатор.

essence_key
required
string or null (basic_essence_key) [ 1 .. 1024 ] characters
Default: null
Example: key01

Ключ.

Responses

Response samples

Content type
application/json
{
  • "tracedata": {
    },
  • "message": "logical",
  • "schema_errors": [ ],
  • "logical_errors": [
    ],
  • "warnings": [ ]
}

Пути рейсов

Получение путей.

Authorizations:
ApiKeyAuth
path Parameters
experiment_key
required
string<uuid> (unique_key)
Example: 11111111-2222-3333-4444-555555555555

Ключ, уникальный идентификатор.

tracks_type
required
string (basic_tracks_type)
Default: "LINE"
Enum: "LINE" "ROAD"
Example: ROAD

Тип трека:

  • LINE - соединение точек остановок по прямой
  • ROAD - соединение точек остановок по дорогам
query Parameters
offset
integer<int32> [ 0 .. 10000000 ]
Default: 0
Example: offset=10

Количество пропущенных сущностей до возвращаемого списка.

limit
integer<int32> [ 1 .. 10000000 ]
Default: 100
Example: limit=10

Максимальное количество возвращаемых сущностей.

Request Body schema: application/json
optional

Фильтр рейсов.

Array of objects (table_trip_filter) [ 0 .. 100 ] items

Список фильтров.

Responses

Response Schema: application/json
required
Array of objects (web_trip_track) [ 0 .. 15001 ] items

Список треков.

required
object (table_list_stats)

Статистика по списку.

Request samples

Content type
application/json
{
  • "filters": [
    ]
}

Response samples

Content type
application/json
{
  • "tracks": [
    ],
  • "statistics": {
    }
}

Диаграмма рейсов

Получение рейсов для отображения на диаграмме.

Authorizations:
ApiKeyAuth
path Parameters
experiment_key
required
string<uuid> (unique_key)
Example: 11111111-2222-3333-4444-555555555555

Ключ, уникальный идентификатор.

query Parameters
offset
integer<int32> [ 0 .. 10000000 ]
Default: 0
Example: offset=10

Количество пропущенных сущностей до возвращаемого списка.

limit
integer<int32> [ 1 .. 10000000 ]
Default: 100
Example: limit=10

Максимальное количество возвращаемых сущностей.

sort_field
string (table_trip_column_type)
Enum: "ESSENCE_KEY" "ENABLED" "PRISTINE" … 28 more
Example: sort_field=ESSENCE_KEY

Название колонки в таблице с рейсами.

sort_direction
string
Default: "ASC"
Enum: "ASC" "DESC"
Example: sort_direction=DESC

Направление сортировки.

Request Body schema: application/json
optional

Фильтр рейсов.

Array of objects (table_trip_filter) [ 0 .. 100 ] items

Список фильтров.

Responses

Response Schema: application/json
required
Array of objects (web_trip_chart) [ 0 .. 15001 ] items

Данные для диаграммы.

required
object (table_list_stats)

Статистика по списку.

Request samples

Content type
application/json
{
  • "filters": [
    ]
}

Response samples

Content type
application/json
{
  • "charts": [
    ],
  • "statistics": {
    }
}

Facts

Управление фактами.