VRt.Studio [ST] (6.20.2289)

Veeroute Studio API.

Description

Server part of the Veeroute Studio.

Entity relationship diagram

erd

Explorer

Folders management.

Create folder

Create new folder.

Authorizations:
ApiKeyAuth
Request Body schema: application/json
required

Folder create request.

parent_key
required
string<uuid> (unique_key)

Key of the folder in which the new folder will be created.

name
required
string [ 1 .. 100 ] characters

New folder name.

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"

Getting a filesystem

Getting a filesystem.

Authorizations:
ApiKeyAuth

Responses

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

Key, unique identifier.

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

Element type:

  • ROOT - root object
  • FOLDER - folder
name
required
string [ 1 .. 100 ] characters

Folder name.

required
object (folder_stats)

Current folder statistics.

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

A list of child's elements.

Response samples

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

Experiment list

Getting a experiments list.

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

Folder key, unique identifier.

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

Filter for searching by text fields - only those experiments are returned whose name or description contains a substring from the filter.

Responses

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

A list of experiments.

required
object (table_list_stats)

Statistics by list.

Response samples

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

Update folder

Rename \ move folder.

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

Folder key, unique identifier.

Request Body schema: application/json
required

Folder update request.

parent_key
required
string<uuid> (unique_key)

Key of the folder in which the new folder will be created.

name
required
string [ 1 .. 100 ] characters

New folder name.

Responses

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

Key, unique identifier.

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

Element type:

  • ROOT - root object
  • FOLDER - folder
name
required
string [ 1 .. 100 ] characters

Folder name.

required
object (folder_stats)

Current folder statistics.

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

A list of child's elements.

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

Folder removal

Folder removal by key.

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

Folder key, unique identifier.

Responses

Response samples

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

Experiments

Experiments management.

Create experiment

Create new experiment.

Authorizations:
ApiKeyAuth
Request Body schema: application/json
required

Experiment create request.

name
required
string [ 1 .. 100 ] characters

Experiment name.

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

Experiment comment.

folder_key
required
string<uuid> (unique_key)

Parent folder key.

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"

Reading experiment

Getting experiment information by key.

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

Key, unique identifier.

Responses

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

Key, unique identifier.

required
object (experiment_specification)

Experiment description.

required
object (experiment_settings)

Experiment settings.

required
object (experiment_statistics)

Experiment statistics.

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

Calculation progress as a percentage, displays the current number of completed steps. The progress of the calculation of the experiment differs from the progress of the planning, as it has a larger number of steps.

object or null (experiment_calculation)

Experiment calculation details.

object or null (experiment_check)

The result of checking the data on the experiment.

pristine
required
boolean (basic_pristine)

A flag indicating whether changes to the entity have been made relative to the original data. true - means that the data is original and has not been changed.

sharing
boolean (basic_sharing)

Experiment sharing flag.

edit_date
required
string<date-time>

Last edit date and time in the ISO 8601 format.

creation_date
required
string<date-time>

Creation date and time in the ISO 8601 format.

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
}

Experiment update

Rename \ move experiment.

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

Key, unique identifier.

Request Body schema: application/json
required

Experiment specification update request.

name
required
string [ 1 .. 100 ] characters

Experiment name.

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

Experiment comment.

folder_key
required
string<uuid> (unique_key)

Parent folder key.

Responses

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

Key, unique identifier.

required
object (experiment_specification)

Experiment description.

required
object (experiment_settings)

Experiment settings.

required
object (experiment_statistics)

Experiment statistics.

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

Calculation progress as a percentage, displays the current number of completed steps. The progress of the calculation of the experiment differs from the progress of the planning, as it has a larger number of steps.

object or null (experiment_calculation)

Experiment calculation details.

object or null (experiment_check)

The result of checking the data on the experiment.

pristine
required
boolean (basic_pristine)

A flag indicating whether changes to the entity have been made relative to the original data. true - means that the data is original and has not been changed.

sharing
boolean (basic_sharing)

Experiment sharing flag.

edit_date
required
string<date-time>

Last edit date and time in the ISO 8601 format.

creation_date
required
string<date-time>

Creation date and time in the ISO 8601 format.

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

Experiment removal

Experiment removal by key.

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

Key, unique identifier.

Responses

Response samples

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

Experiment duplicate

Experiment duplicate.

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

Key, unique identifier.

Request Body schema: application/json
required

Experiment duplicate request.

name
required
string [ 1 .. 100 ] characters

Experiment name.

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

Experiment comment.

folder_key
required
string<uuid> (unique_key)

Parent folder key.

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"

Settings update

Settings update.

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

Key, unique identifier.

Request Body schema: application/json
required

Experiment settings update request.

required
object (plan_settings)

Planning settings.

required
object (replan_settings)

Replanning settings.

required
object (actualize_settings)

Actualize settings.

Responses

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

Key, unique identifier.

required
object (experiment_specification)

Experiment description.

required
object (experiment_settings)

Experiment settings.

required
object (experiment_statistics)

Experiment statistics.

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

Calculation progress as a percentage, displays the current number of completed steps. The progress of the calculation of the experiment differs from the progress of the planning, as it has a larger number of steps.

object or null (experiment_calculation)

Experiment calculation details.

object or null (experiment_check)

The result of checking the data on the experiment.

pristine
required
boolean (basic_pristine)

A flag indicating whether changes to the entity have been made relative to the original data. true - means that the data is original and has not been changed.

sharing
boolean (basic_sharing)

Experiment sharing flag.

edit_date
required
string<date-time>

Last edit date and time in the ISO 8601 format.

creation_date
required
string<date-time>

Creation date and time in the ISO 8601 format.

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

Indicators update

Updating the experiment indicators.

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

Key, unique identifier.

Request Body schema: application/json
required

Indicators update request.

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

Indicator key.

Responses

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

Key, unique identifier.

required
object (experiment_specification)

Experiment description.

required
object (experiment_settings)

Experiment settings.

required
object (experiment_statistics)

Experiment statistics.

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

Calculation progress as a percentage, displays the current number of completed steps. The progress of the calculation of the experiment differs from the progress of the planning, as it has a larger number of steps.

object or null (experiment_calculation)

Experiment calculation details.

object or null (experiment_check)

The result of checking the data on the experiment.

pristine
required
boolean (basic_pristine)

A flag indicating whether changes to the entity have been made relative to the original data. true - means that the data is original and has not been changed.

sharing
boolean (basic_sharing)

Experiment sharing flag.

edit_date
required
string<date-time>

Last edit date and time in the ISO 8601 format.

creation_date
required
string<date-time>

Creation date and time in the ISO 8601 format.

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

Run calculation

Experiment calculation run.

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

Key, unique identifier.

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

Process name:

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

Responses

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

Key, unique identifier.

required
object (experiment_specification)

Experiment description.

required
object (experiment_settings)

Experiment settings.

required
object (experiment_statistics)

Experiment statistics.

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

Calculation progress as a percentage, displays the current number of completed steps. The progress of the calculation of the experiment differs from the progress of the planning, as it has a larger number of steps.

object or null (experiment_calculation)

Experiment calculation details.

object or null (experiment_check)

The result of checking the data on the experiment.

pristine
required
boolean (basic_pristine)

A flag indicating whether changes to the entity have been made relative to the original data. true - means that the data is original and has not been changed.

sharing
boolean (basic_sharing)

Experiment sharing flag.

edit_date
required
string<date-time>

Last edit date and time in the ISO 8601 format.

creation_date
required
string<date-time>

Creation date and time in the ISO 8601 format.

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
}

Calculation stop

Calculation stop.

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

Key, unique identifier.

Responses

Response samples

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

Run validation

Experiment validation run.

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

Key, unique identifier.

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

Process name:

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

Responses

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

Key, unique identifier.

required
object (experiment_specification)

Experiment description.

required
object (experiment_settings)

Experiment settings.

required
object (experiment_statistics)

Experiment statistics.

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

Calculation progress as a percentage, displays the current number of completed steps. The progress of the calculation of the experiment differs from the progress of the planning, as it has a larger number of steps.

object or null (experiment_calculation)

Experiment calculation details.

object or null (experiment_check)

The result of checking the data on the experiment.

pristine
required
boolean (basic_pristine)

A flag indicating whether changes to the entity have been made relative to the original data. true - means that the data is original and has not been changed.

sharing
boolean (basic_sharing)

Experiment sharing flag.

edit_date
required
string<date-time>

Last edit date and time in the ISO 8601 format.

creation_date
required
string<date-time>

Creation date and time in the ISO 8601 format.

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
}

Import (XLSX)

Import (XLSX).

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

Key, unique identifier.

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

Timezone.

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

Data (XLSX).

string<byte> (file_xlsx)

File with data in XLSX format.

Responses

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

Key, unique identifier.

required
object (experiment_specification)

Experiment description.

required
object (experiment_settings)

Experiment settings.

required
object (experiment_statistics)

Experiment statistics.

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

Calculation progress as a percentage, displays the current number of completed steps. The progress of the calculation of the experiment differs from the progress of the planning, as it has a larger number of steps.

object or null (experiment_calculation)

Experiment calculation details.

object or null (experiment_check)

The result of checking the data on the experiment.

pristine
required
boolean (basic_pristine)

A flag indicating whether changes to the entity have been made relative to the original data. true - means that the data is original and has not been changed.

sharing
boolean (basic_sharing)

Experiment sharing flag.

edit_date
required
string<date-time>

Last edit date and time in the ISO 8601 format.

creation_date
required
string<date-time>

Creation date and time in the ISO 8601 format.

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

Import (JSON)

Importing new data from a VRt.Universal JSON file. If the entity is already present in the experiment (determined by its key), it is updated, if not, a new one is created.

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

Key, unique identifier.

Request Body schema: application/json
required

Data (JSON).

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

List of locations used for orders and shifts.

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

Orders list.

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

Available performers list.

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

Available transports list.

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

Assignments list.

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

Existing routes.

object (facts)

Events that have taken place.

object or null (plan_statistics)

General statistics on planned trips.

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

Time and distance matrices list for each transport type from dataset. By specifying an external routing matrix external_routing, parameters geo_settings are not used.

object (plan_settings)

Planning settings.

object (replan_settings)

Replanning settings.

object (actualize_settings)

Actualize settings.

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

The name of the dataset. A technical field that does not affect planning.

Responses

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

Key, unique identifier.

required
object (experiment_specification)

Experiment description.

required
object (experiment_settings)

Experiment settings.

required
object (experiment_statistics)

Experiment statistics.

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

Calculation progress as a percentage, displays the current number of completed steps. The progress of the calculation of the experiment differs from the progress of the planning, as it has a larger number of steps.

object or null (experiment_calculation)

Experiment calculation details.

object or null (experiment_check)

The result of checking the data on the experiment.

pristine
required
boolean (basic_pristine)

A flag indicating whether changes to the entity have been made relative to the original data. true - means that the data is original and has not been changed.

sharing
boolean (basic_sharing)

Experiment sharing flag.

edit_date
required
string<date-time>

Last edit date and time in the ISO 8601 format.

creation_date
required
string<date-time>

Creation date and time in the ISO 8601 format.

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

Import by URL (JSON)

Importing new data from a VRt.Universal JSON file by url. If the entity is already present in the experiment (determined by its key), it is updated, if not, a new one is created.

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

Key, unique identifier.

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

Url to json file.

Responses

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

Key, unique identifier.

required
object (experiment_specification)

Experiment description.

required
object (experiment_settings)

Experiment settings.

required
object (experiment_statistics)

Experiment statistics.

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

Calculation progress as a percentage, displays the current number of completed steps. The progress of the calculation of the experiment differs from the progress of the planning, as it has a larger number of steps.

object or null (experiment_calculation)

Experiment calculation details.

object or null (experiment_check)

The result of checking the data on the experiment.

pristine
required
boolean (basic_pristine)

A flag indicating whether changes to the entity have been made relative to the original data. true - means that the data is original and has not been changed.

sharing
boolean (basic_sharing)

Experiment sharing flag.

edit_date
required
string<date-time>

Last edit date and time in the ISO 8601 format.

creation_date
required
string<date-time>

Creation date and time in the ISO 8601 format.

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

Import by tracecode

Importing new data from a VRt.Universal JSON file by tracecode. If the entity is already present in the experiment (determined by its key), it is updated, if not, a new one is created.

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

Key, unique identifier.

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

Source.

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

Unique process identifier.

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

Sample of loaded data - input task or input task + calculation result.

Responses

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

Key, unique identifier.

required
object (experiment_specification)

Experiment description.

required
object (experiment_settings)

Experiment settings.

required
object (experiment_statistics)

Experiment statistics.

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

Calculation progress as a percentage, displays the current number of completed steps. The progress of the calculation of the experiment differs from the progress of the planning, as it has a larger number of steps.

object or null (experiment_calculation)

Experiment calculation details.

object or null (experiment_check)

The result of checking the data on the experiment.

pristine
required
boolean (basic_pristine)

A flag indicating whether changes to the entity have been made relative to the original data. true - means that the data is original and has not been changed.

sharing
boolean (basic_sharing)

Experiment sharing flag.

edit_date
required
string<date-time>

Last edit date and time in the ISO 8601 format.

creation_date
required
string<date-time>

Creation date and time in the ISO 8601 format.

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

Export (XLSX)

Export (XLSX).

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

Key, unique identifier.

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

Timezone.

Responses

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

File with data in XLSX format.

Response samples

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

Export (JSON)

Export data from the experiment to a VRt.Universal JSON file.

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

Key, unique identifier.

Responses

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

List of locations used for orders and shifts.

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

Orders list.

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

Available performers list.

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

Available transports list.

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

Assignments list.

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

Existing routes.

object (facts)

Events that have taken place.

object or null (plan_statistics)

General statistics on planned trips.

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

Time and distance matrices list for each transport type from dataset. By specifying an external routing matrix external_routing, parameters geo_settings are not used.

object (plan_settings)

Planning settings.

object (replan_settings)

Replanning settings.

object (actualize_settings)

Actualize settings.

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

The name of the dataset. A technical field that does not affect planning.

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

System functions. Auxiliary functionality common to all services.

Checking the availability

Checking the service availability.

Responses

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

Current health.

Response samples

Content type
application/json
{
  • "health": 0.999
}

Getting the service version

Getting the service version.

Responses

Response Schema: application/json
major
required
integer<int32> [ 1 .. 100 ]

Product version. Within a single version, compatibility of common data structures between services is guaranteed. A version change indicates changes that are incompatible with previous versions of the product (and all services).

minor
required
integer<int32> [ 0 .. 111 ]

Minor version of the service. A version change indicates new functionality. The update is backward compatible with the major version of the service.

build
required
string [ 1 .. 64 ] characters

Build version.
Contains backwards compatible bug fixes and docs update.

Response samples

Content type
application/json
{
  • "major": 4,
  • "minor": 4,
  • "build": "1754RC"
}

Getting the documentation

Getting the file with this service documentation.

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

Locations

Locations management.

Locations list

Getting a locations list.

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

Key, unique identifier.

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

The number of items to skip before starting to collect the result set.

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

The number of items to return.

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

Locations table column name.

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

Sort direction.

Request Body schema: application/json
optional

locations filter.

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

A list of filters.

Responses

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

A list.

required
object (table_list_stats)

Statistics by list.

Request samples

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

Response samples

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

Create location

Create location.

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

Key, unique identifier.

Request Body schema: application/json
required

New essence creation request.

required
object (location)

Location - unique geographical location of the object with accessibility parameters.

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

A list of linked essences.

Responses

Request samples

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

Response samples

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

Update location

Updating the location by key.

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

Key, unique identifier.

Request Body schema: application/json
required

Essence update request.

required
object (location)

Location - unique geographical location of the object with accessibility parameters.

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

A list of linked essences.

Responses

Response Schema: application/json
required
object (location)

Location - unique geographical location of the object with accessibility parameters.

object (table_location_fields)

Location fields for table.

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

A list of linked essences.

Request samples

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

Response samples

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

Read location

Getting location information by key.

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

Key, unique identifier.

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

Key, unique identifier.

Responses

Response Schema: application/json
required
object (location)

Location - unique geographical location of the object with accessibility parameters.

object (table_location_fields)

Location fields for table.

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

A list of linked essences.

Response samples

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

Remove location

Removing a location by key.

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

Key, unique identifier.

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

Key, unique identifier.

Responses

Response samples

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

Location geopoints

Getting a geopoints.

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

Key, unique identifier.

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

The number of items to skip before starting to collect the result set.

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

The number of items to return.

Request Body schema: application/json
optional

Locations filter.

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

A list of filters.

Responses

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

A list of points.

required
object (table_list_stats)

Statistics by list.

Request samples

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

Response samples

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

Orders

Orders management.

List orders

Getting a orders list.

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

Key, unique identifier.

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

The number of items to skip before starting to collect the result set.

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

The number of items to return.

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

Order table column name.

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

Sort direction.

Request Body schema: application/json
optional

Essence filter.

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

A list of filters.

Responses

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

A list.

required
object (table_list_stats)

Statistics by list.

Request samples

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

Response samples

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

Create order

New essences creation.

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

Key, unique identifier.

Request Body schema: application/json
required

New essence creation request.

required
object (order)

The order for delivery/transportation, contains a list of demands.

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

A list of linked essences.

Responses

Request samples

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

Response samples

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

Update order

Updating the essence by key.

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

Key, unique identifier.

Request Body schema: application/json
required

Essence update request.

required
object (order)

The order for delivery/transportation, contains a list of demands.

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

A list of linked essences.

Responses

Response Schema: application/json
required
object (order)

The order for delivery/transportation, contains a list of demands.

object (table_order_fields)

Order\demand fields for table.

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

A list of linked essences.

Request samples

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

Response samples

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

Reading order

Getting order information by key.

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

Key, unique identifier.

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

Key, unique identifier.

Responses

Response Schema: application/json
required
object (order)

The order for delivery/transportation, contains a list of demands.

object (table_order_fields)

Order\demand fields for table.

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

A list of linked essences.

Response samples

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

Order removal

Removing a essence by key.

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

Key, unique identifier.

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

Key, unique identifier.

Responses

Response samples

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

Order geopoints

Getting a geopoints.

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

Key, unique identifier.

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

The number of items to skip before starting to collect the result set.

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

The number of items to return.

Request Body schema: application/json
optional

Orders filter.

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

A list of filters.

Responses

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

A list of points.

required
object (table_list_stats)

Statistics by list.

Request samples

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

Response samples

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

Enable orders

Enable orders in the calculation.

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

Key, unique identifier.

Request Body schema: application/json
required

Enable orders request.

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

Key, unique identifier.

Responses

Request samples

Content type
application/json
[
  • "key01"
]

Response samples

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

Disable orders

Disable orders in the calculation.

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

Key, unique identifier.

Request Body schema: application/json
required

Disable orders request.

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

Key, unique identifier.

Responses

Request samples

Content type
application/json
[
  • "key01"
]

Response samples

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

Performers

Performers management.

Performers list

Getting a performers list.

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

Key, unique identifier.

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

The number of items to skip before starting to collect the result set.

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

The number of items to return.

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

Performers table column name.

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

Sort direction.

Request Body schema: application/json
optional

Performers filter.

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

A list of filters.

Responses

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

A list.

required
object (table_list_stats)

Statistics by list.

Request samples

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

Response samples

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

Create performer

Create performer.

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

Key, unique identifier.

Request Body schema: application/json
required

New essence creation request.

required
object (performer)

Performer. Fulfills orders using transport.

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

A list of linked essences.

Responses

Request samples

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

Response samples

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

Update performer

Updating the performer by key.

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

Key, unique identifier.

Request Body schema: application/json
required

Essence update request.

required
object (performer)

Performer. Fulfills orders using transport.

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

A list of linked essences.

Responses

Response Schema: application/json
required
object (performer)

Performer. Fulfills orders using transport.

object (table_performer_fields)

Performer and shift fields for table.

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

A list of linked essences.

Request samples

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

Response samples

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

Read performer

Getting performer information by key.

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

Key, unique identifier.

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

Key, unique identifier.

Responses

Response Schema: application/json
required
object (performer)

Performer. Fulfills orders using transport.

object (table_performer_fields)

Performer and shift fields for table.

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

A list of linked essences.

Response samples

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

Remove performer

Removing a performer by key.

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

Key, unique identifier.

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

Key, unique identifier.

Responses

Response samples

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

Performer geopoints

Getting a geopoints.

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

Key, unique identifier.

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

The number of items to skip before starting to collect the result set.

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

The number of items to return.

Request Body schema: application/json
optional

Performers filter.

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

A list of filters.

Responses

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

A list of points.

required
object (table_list_stats)

Statistics by list.

Request samples

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

Response samples

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

Enable performers

Enable performers in the calculation.

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

Key, unique identifier.

Request Body schema: application/json
required

Enable performers request.

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

Key, unique identifier.

Responses

Request samples

Content type
application/json
[
  • "key01"
]

Response samples

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

Disable performers

Disable performers in the calculation.

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

Key, unique identifier.

Request Body schema: application/json
required

Disable performers request.

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

Key, unique identifier.

Responses

Request samples

Content type
application/json
[
  • "key01"
]

Response samples

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

Transports

Transports management.

Transport list

Getting a transport list.

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

Key, unique identifier.

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

The number of items to skip before starting to collect the result set.

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

The number of items to return.

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

Transport table column name.

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

Sort direction.

Request Body schema: application/json
optional

Transport filter.

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

A list of filters.

Responses

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

A list.

required
object (table_list_stats)

Statistics by list.

Request samples

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

Response samples

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

Create transport

New essences creation.

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

Key, unique identifier.

Request Body schema: application/json
required

New essence creation request.

required
object (transport)

Transport. Used by performer for relocating and cargo transfer.

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

A list of linked essences.

Responses

Request samples

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

Response samples

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

Update transport

Updating the essence by key.

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

Key, unique identifier.

Request Body schema: application/json
required

Essence update request.

required
object (transport)

Transport. Used by performer for relocating and cargo transfer.

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

A list of linked essences.

Responses

Response Schema: application/json
required
object (transport)

Transport. Used by performer for relocating and cargo transfer.

object (table_transport_fields)

Transport\shift fields for table.

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

A list of linked essences.

Request samples

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

Response samples

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

Reading transport

Getting transport information by key.

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

Key, unique identifier.

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

Key, unique identifier.

Responses

Response Schema: application/json
required
object (transport)

Transport. Used by performer for relocating and cargo transfer.

object (table_transport_fields)

Transport\shift fields for table.

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

A list of linked essences.

Response samples

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

Remove transport

Removing a transport by key.

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

Key, unique identifier.

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

Key, unique identifier.

Responses

Response samples

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

Transport geopoints

Getting a geopoints.

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

Key, unique identifier.

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

The number of items to skip before starting to collect the result set.

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

The number of items to return.

Request Body schema: application/json
optional

Transports filter.

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

A list of filters.

Responses

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

A list of points.

required
object (table_list_stats)

Statistics by list.

Request samples

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

Response samples

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

Enable transports

Enable transports in the calculation.

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

Key, unique identifier.

Request Body schema: application/json
required

Enable transports request.

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

Key, unique identifier.

Responses

Request samples

Content type
application/json
[
  • "key01"
]

Response samples

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

Disable transports

Disable transports in the calculation.

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

Key, unique identifier.

Request Body schema: application/json
required

Disable transports request.

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

Key, unique identifier.

Responses

Request samples

Content type
application/json
[
  • "key01"
]

Response samples

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

Trips

Trips management.

Trip list

Getting a trips list.

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

Key, unique identifier.

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

The number of items to skip before starting to collect the result set.

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

The number of items to return.

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

Trip table column name.

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

Sort direction.

Request Body schema: application/json
optional

Trip filter.

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

A list of filters.

Responses

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

A list.

required
object (table_list_stats)

Statistics by list.

Request samples

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

Response samples

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

Trip create

New essences creation.

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

Key, unique identifier.

Request Body schema: application/json
required

New essence creation request.

required
object (trip)

A trip is a sequence of states assigned to the specified performer driving the specified transport.

required
object (trip_statistics)

Statistics for a specific trip.

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

A list of linked essences.

Responses

Request samples

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

Response samples

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

Trip update

Updating the essence by key.

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

Key, unique identifier.

Request Body schema: application/json
required

Essence update request.

required
object (trip)

A trip is a sequence of states assigned to the specified performer driving the specified transport.

required
object (trip_statistics)

Statistics for a specific trip.

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

A list of linked essences.

Responses

Response Schema: application/json
required
object (trip)

A trip is a sequence of states assigned to the specified performer driving the specified transport.

required
object (trip_statistics)

Statistics for a specific trip.

object (table_trip_fields)

Trip\stops fields for table.

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

A list of linked essences.

Request samples

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

Response samples

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

Read trip

Getting trip information by key.

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

Key, unique identifier.

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

Key, unique identifier.

Responses

Response Schema: application/json
required
object (trip)

A trip is a sequence of states assigned to the specified performer driving the specified transport.

required
object (trip_statistics)

Statistics for a specific trip.

object (table_trip_fields)

Trip\stops fields for table.

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

A list of linked essences.

Response samples

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

Remove trip

Removing a trip by key.

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

Key, unique identifier.

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

Key, unique identifier.

Responses

Response samples

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

Trip tracks

Getting a tracks.

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

Key, unique identifier.

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

Track type:

  • LINE - connecting stop points in a straight line
  • ROAD - connecting stop points along roads
query Parameters
offset
integer<int32> [ 0 .. 10000000 ]
Default: 0
Example: offset=10

The number of items to skip before starting to collect the result set.

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

The number of items to return.

Request Body schema: application/json
optional

Trips filter.

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

A list of filters.

Responses

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

A list of tracks.

required
object (table_list_stats)

Statistics by list.

Request samples

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

Response samples

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

Trips chart

Getting a trips for chart.

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

Key, unique identifier.

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

The number of items to skip before starting to collect the result set.

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

The number of items to return.

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

Trip table column name.

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

Sort direction.

Request Body schema: application/json
optional

Trips filter.

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

A list of filters.

Responses

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

Data for chart.

required
object (table_list_stats)

Statistics by list.

Request samples

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

Response samples

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

Facts

Facts management.