VRt.Admin [AD] (7.11.2593)

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

Veeroute company website

Description

Veeroute Admin Panel.

Entity relationship diagram

erd

Companies

Company management.

Companies list

Getting a list of companies.

Authorizations:

ApiKeyAuth

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.
filter	string [ 1 .. 64 ] characters Example: filter=example text Filter for searching by text fields.
sort_field	string [ 1 .. 64 ] characters Example: sort_field=name Field to sort by.
sort_direction	string Default: "ASC" Enum: "ASC" "DESC" Example: sort_direction=DESC Sort direction.

Responses

Response Schema: application/json

required	Array of objects (company) [ 0 .. 10000000 ] items A list of companies.
required	object (company_list_counters) Statistics by company list.

Response samples

Content type

application/json

{"companies": [{"key": "smart_company",
"specification": "Company full name"
}
],
"counters": {"overall": {"total": 1
},
"filter": {"total": 1
}
}
}

Company creation

New company creation.

Authorizations:

ApiKeyAuth

Request Body schema: application/json
required

Company creation request.

key required	string (company_key) [ 3 .. 256 ] characters \w+ Example: "smart_company" Unique company key.
specification	string or null [ 2 .. 256 ] characters Default: null Example: "Company full name" Company specification.

Responses

Response Schema: application/json

key required	string (company_key) [ 3 .. 256 ] characters \w+ Example: "smart_company" Unique company key.
specification	string or null [ 2 .. 256 ] characters Default: null Example: "Company full name" Company specification.

Request samples

Payload

Content type

application/json

{"key": "smart_company",
"specification": "Company full name"
}

Response samples

Content type

application/json

{"key": "smart_company",
"specification": "Company full name"
}

Company update

Updating the company information.

Authorizations:

ApiKeyAuth

Request Body schema: application/json
required

Company update request.

key required	string (company_key) [ 3 .. 256 ] characters \w+ Example: "smart_company" Unique company key.
specification	string or null [ 2 .. 256 ] characters Default: null Example: "Company full name" Company specification.

Responses

Response Schema: application/json

key required	string (company_key) [ 3 .. 256 ] characters \w+ Example: "smart_company" Unique company key.
specification	string or null [ 2 .. 256 ] characters Default: null Example: "Company full name" Company specification.

Request samples

Payload

Content type

application/json

{"key": "smart_company",
"specification": "Company full name"
}

Response samples

Content type

application/json

{"key": "smart_company",
"specification": "Company full name"
}

Getting company information

Getting company information by key.

Authorizations:

ApiKeyAuth

path Parameters

company_key

required

string (company_key) [ 3 .. 256 ] characters \w+

Example: smart_company

Parameter (path) with company key.

Responses

Response Schema: application/json

key required	string (company_key) [ 3 .. 256 ] characters \w+ Example: "smart_company" Unique company key.
specification	string or null [ 2 .. 256 ] characters Default: null Example: "Company full name" Company specification.

Response samples

Content type

application/json

{"key": "smart_company",
"specification": "Company full name"
}

Company removal

Removing a company by key.

Authorizations:

ApiKeyAuth

path Parameters

company_key

required

string (company_key) [ 3 .. 256 ] characters \w+

Example: smart_company

Parameter (path) with company key.

Responses

Response samples

Content type

application/json

{"tracedata": {"process_code": "11111111-2222-3333-4444-555555555555",
"request_code": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee",
"username": "username_for_login",
"company": "smart_company",
"service": "UNIVERSAL",
"operation": "run_plan_calculation",
"env": "edge7",
"pod": "11111111-2222-3333-4444-555555555555",
"time": "2024-11-21T09:30:00+03:00"
},
"message": "Bad Request"
}

Users

Users management.

Users list

Getting a list of users.

Authorizations:

ApiKeyAuth

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.
filter	string [ 1 .. 64 ] characters Example: filter=example text Filter for searching by text fields.
sort_field	string [ 1 .. 64 ] characters Example: sort_field=name Field to sort by.
sort_direction	string Default: "ASC" Enum: "ASC" "DESC" Example: sort_direction=DESC Sort direction.
company_key	string (company_key) [ 3 .. 256 ] characters \w+ Example: company_key=smart_company Parameter (query) with company key.
user_group	string (user_groups) Default: "TOTAL" Enum: "TOTAL" "ACTIVE" "BLOCKED" … 1 more Example: user_group=ACTIVE Users logic groups.

Responses

Response Schema: application/json

required	Array of objects (user) [ 0 .. 10000000 ] items A list of users.
required	object (user_list_counters) Statistics by users list.

Response samples

Content type

application/json

{"users": [{"username": "username_for_login",
"specification": "User full name",
"email": "admin@company.com",
"phone": "+71112223333",
"company_key": "smart_company",
"enabled": true,
"roles": ["USER"
],
"timezone": 3,
"edit_date": "2024-11-21T19:45:00Z",
"creation_date": "2024-11-21T19:45:00Z",
"attributes": [ ]
}
],
"counters": {"overall": {"total": 1,
"active": 1,
"blocked": 1,
"admins": 1
},
"filter": {"total": 1,
"active": 1,
"blocked": 1,
"admins": 1
}
}
}

User creation

New user creation.

Authorizations:

ApiKeyAuth

Request Body schema: application/json
required

User creation request.

username required	string (user_username) [ 2 .. 256 ] characters \w+ Example: "username_for_login" Unique username for login.
password	string or null <password> (user_password) [ 10 .. 256 ] characters Example: "long_strong_password" Password.
specification	string or null (user_specification) [ 2 .. 256 ] characters Example: "User full name" User specification.
email	string or null <email> (user_email) [ 5 .. 256 ] characters Example: "admin@company.com" User e-mail address.
phone	string or null (user_phone) [ 5 .. 32 ] characters Example: "+71112223333" User phone.
company_key required	string (company_key) [ 3 .. 256 ] characters \w+ Example: "smart_company" Unique company key.
enabled	boolean Default: true Example: "true" User status.
roles required	Array of strings (user_role_list) [ 0 .. 2 ] items unique Items Enum: "ADMIN" "PARTNER" "USER" … 1 more Example: "USER" List of user roles.
timezone	integer <int32> (timezone) [ -12 .. 12 ] Example: "3" Basic time zone used for statistics.
	Array of objects (attributes) [ 0 .. 1000 ] items unique Attributes. Used to add service information.

Responses

Response Schema: application/json

username required	string (user_username) [ 2 .. 256 ] characters \w+ Example: "username_for_login" Unique username for login.
specification	string or null (user_specification) [ 2 .. 256 ] characters Example: "User full name" User specification.
email	string or null <email> (user_email) [ 5 .. 256 ] characters Example: "admin@company.com" User e-mail address.
phone	string or null (user_phone) [ 5 .. 32 ] characters Example: "+71112223333" User phone.
company_key required	string (company_key) [ 3 .. 256 ] characters \w+ Example: "smart_company" Unique company key.
enabled	boolean Default: true Example: "true" User status.
roles required	Array of strings (user_role_list) [ 0 .. 2 ] items unique Items Enum: "ADMIN" "PARTNER" "USER" … 1 more Example: "USER" List of user roles.
timezone	integer <int32> (timezone) [ -12 .. 12 ] Example: "3" Basic time zone used for statistics.
edit_date	string or null <date-time> Default: null Example: "2024-11-21T19:45:00Z" Last edit date and time in the ISO 8601 format.
creation_date	string or null <date-time> Default: null Example: "2024-11-21T19:45:00Z" Creation date and time in the ISO 8601 format.
	Array of objects (attributes) [ 0 .. 1000 ] items unique Attributes. Used to add service information.

Request samples

Payload

Content type

application/json

{"username": "username_for_login",
"password": "long_strong_password",
"specification": "User full name",
"email": "admin@company.com",
"phone": "+71112223333",
"company_key": "smart_company",
"enabled": true,
"roles": ["USER"
],
"timezone": 3,
"attributes": [ ]
}

Response samples

Content type

application/json

{"username": "username_for_login",
"specification": "User full name",
"email": "admin@company.com",
"phone": "+71112223333",
"company_key": "smart_company",
"enabled": true,
"roles": ["USER"
],
"timezone": 3,
"edit_date": "2024-11-21T19:45:00Z",
"creation_date": "2024-11-21T19:45:00Z",
"attributes": [ ]
}

Account update

Updating the user information by login. The username field cannot be changed.

Authorizations:

ApiKeyAuth

Request Body schema: application/json
required

User update request.

username required	string (user_username) [ 2 .. 256 ] characters \w+ Example: "username_for_login" Unique username for login.
password	string or null <password> (user_password) [ 10 .. 256 ] characters Example: "long_strong_password" Password.
specification	string or null (user_specification) [ 2 .. 256 ] characters Example: "User full name" User specification.
email	string or null <email> (user_email) [ 5 .. 256 ] characters Example: "admin@company.com" User e-mail address.
phone	string or null (user_phone) [ 5 .. 32 ] characters Example: "+71112223333" User phone.
company_key required	string (company_key) [ 3 .. 256 ] characters \w+ Example: "smart_company" Unique company key.
enabled	boolean Default: true Example: "true" User status.
roles required	Array of strings (user_role_list) [ 0 .. 2 ] items unique Items Enum: "ADMIN" "PARTNER" "USER" … 1 more Example: "USER" List of user roles.
timezone	integer <int32> (timezone) [ -12 .. 12 ] Example: "3" Basic time zone used for statistics.
	Array of objects (attributes) [ 0 .. 1000 ] items unique Attributes. Used to add service information.

Responses

Response Schema: application/json

username required	string (user_username) [ 2 .. 256 ] characters \w+ Example: "username_for_login" Unique username for login.
specification	string or null (user_specification) [ 2 .. 256 ] characters Example: "User full name" User specification.
email	string or null <email> (user_email) [ 5 .. 256 ] characters Example: "admin@company.com" User e-mail address.
phone	string or null (user_phone) [ 5 .. 32 ] characters Example: "+71112223333" User phone.
company_key required	string (company_key) [ 3 .. 256 ] characters \w+ Example: "smart_company" Unique company key.
enabled	boolean Default: true Example: "true" User status.
roles required	Array of strings (user_role_list) [ 0 .. 2 ] items unique Items Enum: "ADMIN" "PARTNER" "USER" … 1 more Example: "USER" List of user roles.
timezone	integer <int32> (timezone) [ -12 .. 12 ] Example: "3" Basic time zone used for statistics.
edit_date	string or null <date-time> Default: null Example: "2024-11-21T19:45:00Z" Last edit date and time in the ISO 8601 format.
creation_date	string or null <date-time> Default: null Example: "2024-11-21T19:45:00Z" Creation date and time in the ISO 8601 format.
	Array of objects (attributes) [ 0 .. 1000 ] items unique Attributes. Used to add service information.

Request samples

Payload

Content type

application/json

{"username": "username_for_login",
"password": "long_strong_password",
"specification": "User full name",
"email": "admin@company.com",
"phone": "+71112223333",
"company_key": "smart_company",
"enabled": true,
"roles": ["USER"
],
"timezone": 3,
"attributes": [ ]
}

Response samples

Content type

application/json

{"username": "username_for_login",
"specification": "User full name",
"email": "admin@company.com",
"phone": "+71112223333",
"company_key": "smart_company",
"enabled": true,
"roles": ["USER"
],
"timezone": 3,
"edit_date": "2024-11-21T19:45:00Z",
"creation_date": "2024-11-21T19:45:00Z",
"attributes": [ ]
}

User information

Getting user information by login.

Authorizations:

ApiKeyAuth

path Parameters

username

required

string (user_username) [ 2 .. 256 ] characters \w+

Example: username_for_login

Parameter (path) with username.

Responses

Response Schema: application/json

username required	string (user_username) [ 2 .. 256 ] characters \w+ Example: "username_for_login" Unique username for login.
specification	string or null (user_specification) [ 2 .. 256 ] characters Example: "User full name" User specification.
email	string or null <email> (user_email) [ 5 .. 256 ] characters Example: "admin@company.com" User e-mail address.
phone	string or null (user_phone) [ 5 .. 32 ] characters Example: "+71112223333" User phone.
company_key required	string (company_key) [ 3 .. 256 ] characters \w+ Example: "smart_company" Unique company key.
enabled	boolean Default: true Example: "true" User status.
roles required	Array of strings (user_role_list) [ 0 .. 2 ] items unique Items Enum: "ADMIN" "PARTNER" "USER" … 1 more Example: "USER" List of user roles.
timezone	integer <int32> (timezone) [ -12 .. 12 ] Example: "3" Basic time zone used for statistics.
edit_date	string or null <date-time> Default: null Example: "2024-11-21T19:45:00Z" Last edit date and time in the ISO 8601 format.
creation_date	string or null <date-time> Default: null Example: "2024-11-21T19:45:00Z" Creation date and time in the ISO 8601 format.
	Array of objects (attributes) [ 0 .. 1000 ] items unique Attributes. Used to add service information.

Response samples

Content type

application/json

{"username": "username_for_login",
"specification": "User full name",
"email": "admin@company.com",
"phone": "+71112223333",
"company_key": "smart_company",
"enabled": true,
"roles": ["USER"
],
"timezone": 3,
"edit_date": "2024-11-21T19:45:00Z",
"creation_date": "2024-11-21T19:45:00Z",
"attributes": [ ]
}

User removal

Removing a user by login.

Authorizations:

ApiKeyAuth

path Parameters

username

required

string (user_username) [ 2 .. 256 ] characters \w+

Example: username_for_login

Parameter (path) with username.

Responses

Response samples

Content type

application/json

{"tracedata": {"process_code": "11111111-2222-3333-4444-555555555555",
"request_code": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee",
"username": "username_for_login",
"company": "smart_company",
"service": "UNIVERSAL",
"operation": "run_plan_calculation",
"env": "edge7",
"pod": "11111111-2222-3333-4444-555555555555",
"time": "2024-11-21T09:30:00+03:00"
},
"message": "Bad Request"
}

Audit

User actions.

User actions

User actions for the period. If the period is not specified, records for the current day are returned from the beginning of the day to the current time. If username is empty, report on all users are processed.

Authorizations:

ApiKeyAuth

query Parameters

company_key	string (company_key) [ 3 .. 256 ] characters \w+ Example: company_key=smart_company Parameter (query) with company key.
username	string (user_username) [ 2 .. 256 ] characters \w+ Example: username=username_for_login Parameter (query) with username.
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.
from	string <date-time> Example: from=2024-11-21T09:30:00+03:00 Date and time in the ISO 8601 format. If no datetime is specified, audit data are returned from the beginning of the day.
to	string <date-time> Example: to=2024-11-21T18:00:00+03:00 Date and time in the ISO 8601 format. If not specified, data up to the current time is returned.
service	string (service) Enum: "UNIVERSAL" "ROUTING" "ACCOUNT" … 5 more Example: service=UNIVERSAL Service name.
operation	string (operation) [ 3 .. 256 ] characters \w+ Example: operation=run_plan_calculation Operation name.
process_type	string (process_type) Enum: "NOTRACE" "TRACE" "PLAN" … 4 more Example: process_type=PLAN Process type.
status	string (calculation_status) Enum: "WAITING" "IN_PROGRESS" "FINISHED_IN_TIME" … 5 more Example: status=FINISHED_IN_TIME Process status.
sort_field	string [ 1 .. 64 ] characters Example: sort_field=name Field to sort by.
sort_direction	string Default: "ASC" Enum: "ASC" "DESC" Example: sort_direction=DESC Sort direction.

Responses

Response Schema: application/json

required	Array of objects (audit_action) [ 0 .. 10000000 ] items User audit data list.
required	object (audit_counters) Counters by records list.

Response samples

Content type

application/json

{"actions": [{"process_code": "11111111-2222-3333-4444-555555555555",
"process_type": "PLAN",
"username": "username_for_login",
"company": "smart_company",
"service": "UNIVERSAL",
"time": "2024-11-21T09:30:00+03:00",
"requests": [{"process_code": "11111111-2222-3333-4444-555555555555",
"request_code": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee",
"username": "username_for_login",
"company": "smart_company",
"service": "UNIVERSAL",
"operation": "run_plan_calculation",
"env": "edge7",
"pod": "11111111-2222-3333-4444-555555555555",
"time": "2024-11-21T09:30:00+03:00"
}
],
"statistics": {"request_points_count": 1500,
"result_elements_count": 500,
"calculation_info": {"status": "FINISHED_IN_TIME",
"result_version": 133,
"preparing_time": "PT1H45M",
"business_validation_time": "PT1H45M",
"math_validation_time": "PT1H45M",
"waiting_time": "PT1H45M",
"calculation_time": "PT1H45M"
}
},
"input_file_exists": true,
"output_file_exists": true
}
],
"counters": {"overall": {"total": 1
},
"filter": {"total": 1
}
}
}

Data

User data.

Reading input data

Receiving an incoming request by tracedata.process_code.

Authorizations:

ApiKeyAuth

path Parameters

process_code

required

string <uuid> (process_code)

Example: 11111111-2222-3333-4444-555555555555

Unique process identifier.

query Parameters

data_flow_type	string (flow_type) Default: "INPUT" Enum: "INPUT" "OUTPUT" Example: data_flow_type=OUTPUT Data flow type.
data_flow_stage	string Default: "RAW" Value: "RAW" Example: data_flow_stage=RAW Data flow stage.

Responses

Response Schema: application/octet-stream

string <byte> (file_binary)

File with data (octet-stream).

Response samples

Content type

application/json

{"tracedata": {"process_code": "11111111-2222-3333-4444-555555555555",
"request_code": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee",
"username": "username_for_login",
"company": "smart_company",
"service": "UNIVERSAL",
"operation": "run_plan_calculation",
"env": "edge7",
"pod": "11111111-2222-3333-4444-555555555555",
"time": "2024-11-21T09:30:00+03:00"
},
"message": "Bad Request"
}

Statistics

Statistics.

Statistics for the period

User statistics for the period. If username is empty, statistics on all users are processed. If the period is not specified, the statistics for the current month returns (from the beginning of the month to the present day). If no from datetime is specified, data are returned from the beginning of the month. If no to datetime is specified, data are returned be to the present day (excluding). Empty service and process type fields mean returning statistics for all services and process types.

Authorizations:

ApiKeyAuth

query Parameters

username	string (user_username) [ 2 .. 256 ] characters \w+ Example: username=username_for_login Parameter (query) with username.
from	string <date> Example: from=2024-11-22 Date `from` in the YYYY-MM-DD format.
to	string <date> Example: to=2024-11-26 Date `to` (including) in the YYYY-MM-DD format.
service	string (service) Enum: "UNIVERSAL" "ROUTING" "ACCOUNT" … 5 more Example: service=UNIVERSAL Service name.
process_type	string (process_type) Enum: "NOTRACE" "TRACE" "PLAN" … 4 more Example: process_type=PLAN Process type.

Responses

Response Schema: application/json

required

Array of objects (user_statistics) [ 0 .. 10000000 ] items

User statistics list.

Response samples

Content type

application/json

{"users": [{"username": "user_one",
"dates": [{"date": "2024-11-15",
"services": [{"service": "UNIVERSAL",
"processes": [{"process_type": "PLAN",
"unique_points_per_day": 1,
"points_per_day": 2,
"elements_per_day": 1,
"processes_per_day": 1
}
]
}
]
}
]
}
]
}

Reporting

Report by user for the period. If username is empty, report on all users are processed. If the period is not specified, the report for the current month returns (from the beginning of the month to the present day). If no from datetime is specified, data are returned from the beginning of the month. If no to datetime is specified, data are returned be to the present day (excluding). Empty service and process type fields mean returning statistics for all services and process types.

Authorizations:

ApiKeyAuth

query Parameters

username	string (user_username) [ 2 .. 256 ] characters \w+ Example: username=username_for_login Parameter (query) with username.
from	string <date> Example: from=2024-11-22 Date `from` in the YYYY-MM-DD format.
to	string <date> Example: to=2024-11-26 Date `to` (including) in the YYYY-MM-DD format.
service	string (service) Enum: "UNIVERSAL" "ROUTING" "ACCOUNT" … 5 more Example: service=UNIVERSAL Service name.
process_type	string (process_type) Enum: "NOTRACE" "TRACE" "PLAN" … 4 more Example: process_type=PLAN Process type.

Responses

Response Schema: application/octet-stream

string <byte> (file_xlsx)

File with data in XLSX format.

Response samples

Content type

application/json

{"tracedata": {"process_code": "11111111-2222-3333-4444-555555555555",
"request_code": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee",
"username": "username_for_login",
"company": "smart_company",
"service": "UNIVERSAL",
"operation": "run_plan_calculation",
"env": "edge7",
"pod": "11111111-2222-3333-4444-555555555555",
"time": "2024-11-21T09:30:00+03:00"
},
"message": "Bad Request"
}

Quota

Quota.

Setting the quotas

Setting the quotas for the user.

Authorizations:

ApiKeyAuth

path Parameters

username

required

string (user_username) [ 2 .. 256 ] characters \w+

Example: username_for_login

Parameter (path) with username.

Request Body schema: application/json
required

Request to change the quota.

required

Array of objects (service_quota) [ 1 .. 8 ] items unique

All services quota list.

Responses

Request samples

Payload

Content type

application/json

{"services": [{"service": "UNIVERSAL",
"processes": [{"process_type": "PLAN",
"points_per_request": 1500,
"points_per_day": 25000,
"max_concurrent_execution": 5
}
]
}
]
}

Response samples

Content type

application/json

{"tracedata": {"process_code": "11111111-2222-3333-4444-555555555555",
"request_code": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee",
"username": "username_for_login",
"company": "smart_company",
"service": "UNIVERSAL",
"operation": "run_plan_calculation",
"env": "edge7",
"pod": "11111111-2222-3333-4444-555555555555",
"time": "2024-11-21T09:30:00+03:00"
},
"message": "Bad Request"
}

Obtaining the quotas

Obtaining the quotas for the user.

Authorizations:

ApiKeyAuth

path Parameters

username

required

string (user_username) [ 2 .. 256 ] characters \w+

Example: username_for_login

Parameter (path) with username.

Responses

Response Schema: application/json

required

object (quota_base)

All services quota.

Response samples

Content type

application/json

{"base": {"services": [{"service": "UNIVERSAL",
"processes": [{"process_type": "PLAN",
"points_per_request": 1500,
"points_per_day": 25000,
"max_concurrent_execution": 5
}
]
}
]
}
}

Quota removal

Quota removal for the user.

Authorizations:

ApiKeyAuth

path Parameters

username

required

string (user_username) [ 2 .. 256 ] characters \w+

Example: username_for_login

Parameter (path) with username.

Responses

Response samples

Content type

application/json

{"tracedata": {"process_code": "11111111-2222-3333-4444-555555555555",
"request_code": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee",
"username": "username_for_login",
"company": "smart_company",
"service": "UNIVERSAL",
"operation": "run_plan_calculation",
"env": "edge7",
"pod": "11111111-2222-3333-4444-555555555555",
"time": "2024-11-21T09:30:00+03:00"
},
"message": "Bad Request"
}

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 ]

Example: "0.999"

The current health indicator of the service.

0.0 means the service is not ready to perform tasks.
1.0 means the service is fully ready to perform tasks.

Response samples

200
404
429
500

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 ] Example: "7" 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 ] Example: "15" 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 Example: "3754RC" Build version. Contains backwards compatible bug fixes and docs update.

Response samples

200
404
429
500

Content type

application/json

{"major": 7,
"minor": 15,
"build": "3754RC"
}

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:
text/html

string (file_html)

File with data in HTML format.

Response samples

404
429
500

Content type

application/json

{"resource_key": "resource_key",
"detail": {"tracedata": {"process_code": "11111111-2222-3333-4444-555555555555",
"request_code": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee",
"username": "username_for_login",
"company": "smart_company",
"service": "UNIVERSAL",
"operation": "run_plan_calculation",
"env": "edge7",
"pod": "11111111-2222-3333-4444-555555555555",
"time": "2024-11-21T09:30:00+03:00"
}
}
}

VRt.Admin [AD] (7.11.2593)

Description

Entity relationship diagram

Companies

Companies list

Authorizations:

query Parameters

Responses

Response Schema: application/json

Response samples

Company creation

Authorizations:

Request Body schema: application/jsonrequired

Responses

Response Schema: application/json

Request samples

Response samples

Company update

Authorizations:

Request Body schema: application/jsonrequired

Responses

Response Schema: application/json

Request samples

Response samples

Getting company information

Authorizations:

path Parameters

Responses

Response Schema: application/json

Response samples

Company removal

Authorizations:

path Parameters

Responses

Response samples

Users

Users list

Authorizations:

query Parameters

Responses

Response Schema: application/json

Response samples

User creation

Authorizations:

Request Body schema: application/jsonrequired

Responses

Response Schema: application/json

Request samples

Response samples

Account update

Authorizations:

Request Body schema: application/jsonrequired

Responses

Response Schema: application/json

Request samples

Response samples

User information

Authorizations:

path Parameters

Responses

Response Schema: application/json

Response samples

User removal

Authorizations:

path Parameters

Responses

Response samples

Audit

User actions

Authorizations:

query Parameters

Responses

Response Schema: application/json

Response samples

Data

Reading input data

Authorizations:

path Parameters

query Parameters

Responses

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Response Schema:
text/html