VRt.Registry [RG] (7.24.2983)

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

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

Сайт компании Veeroute

Описание

Сервис предназначен для управления конфигурационными файлами.

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

erd

Explorer

Управление виртуальной файловой системой.

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

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

Authorizations:

ApiKeyAuth

Request Body schema: application/json
required

Запрос на создание папки. В поле parent_key необходимо указать ключ папки, в которой будет создана новая папка. Если parent_key не указан - папка создается в корне.

parent_key	string or null <uuid> (folder_parent_key) Example: "11111111-2222-3333-4444-555555555555" Ключ родительской папки, `null` если папка корневая.
name required	string (folder_name) [ 1 .. 100 ] characters Example: "folder_1" Название папки.
comment	string or null (folder_comment) [ 0 .. 10000 ] characters Example: "long long long long text" Комментарий к папке.
color	string or null (folder_color) [ 1 .. 20 ] characters Example: "red" Цвет папки.
expiration_date	string or null <date-time> (folder_expiration_date) Example: "2025-11-21T19:45:00Z" Дата и время автоматического удаления в соответствии с ISO 8601. Null означает что автоматическое удаление не происходит.
	Array of objects (attributes) [ 0 .. 250 ] items unique Атрибуты. Используются для указания служебной информации.

Responses

Response Schema: application/json

string <uuid> (unique_key)

Ключ созданной папки.

Request samples

Payload

Content type

application/json

{"parent_key": "11111111-2222-3333-4444-555555555555",
"name": "folder_1",
"comment": "long long long long text",
"color": "red",
"expiration_date": "2025-11-21T19:45:00Z",
"attributes": [ ]
}

Response samples

Content type

application/json

"11111111-2222-3333-4444-555555555555"

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

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

Authorizations:

ApiKeyAuth

query Parameters

folder_key	string <uuid> (unique_key) Example: folder_key=11111111-2222-3333-4444-555555555555 Ключ родительской папки, если не указан - возвращается список корневых папок
filter	string [ 1 .. 64 ] characters Example: filter=example text Фильтр для поиска по текстовым полям - возвращаются только те папки, у которых содержится подстрока из фильтра: в названии папки в комментарии к папке
offset	integer <int32> [ 0 .. 10000000 ] Default: 0 Example: offset=10 Количество пропущенных сущностей до возвращаемого списка.
limit	integer <int32> [ 1 .. 2001 ] Default: 100 Example: limit=10 Максимальное количество возвращаемых сущностей.
sort_field	string (filesystem_column_type) Default: "NAME" Enum: "NAME" "OWNER_COMPANY_KEY" "OWNER_USERNAME" … 4 more Example: sort_field=CREATION_DATE Название колонки в таблице с папками.
sort_direction	string Default: "ASC" Enum: "ASC" "DESC" Example: sort_direction=DESC Направление сортировки.

Responses

Response Schema: application/json

required	object (folder) Папка - элемент виртуальной файловой системы.
required	Array of objects (folder) [ 0 .. 2001 ] items Список папок.
required	object (table_list_counters) Счетчики по списку.

Response samples

Content type

application/json

{"folders": [{"key": "2bff0b86-2ddc-445c-9d98-f75ca2eec091",
"parent_key": "65fb88e5-128d-4f3f-9a50-4c2754adcbed",
"name": "My Folder",
"owner_company_key": "veeroute",
"owner_username": "username_1",
"comment": "long text",
"counters": {"folders_count": 0,
"files_count": 3
}
}
],
"counters": {"overall": {"total": 20
},
"filter": {"total": 1
}
}
}

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

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

Authorizations:

ApiKeyAuth

path Parameters

folder_key

required

string <uuid> (unique_key)

Example: 11111111-2222-3333-4444-555555555555

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

Request Body schema: application/json
required

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

parent_key	string or null <uuid> (folder_parent_key) Example: "11111111-2222-3333-4444-555555555555" Ключ родительской папки, `null` если папка корневая.
name required	string (folder_name) [ 1 .. 100 ] characters Example: "folder_1" Название папки.
comment	string or null (folder_comment) [ 0 .. 10000 ] characters Example: "long long long long text" Комментарий к папке.
color	string or null (folder_color) [ 1 .. 20 ] characters Example: "red" Цвет папки.
expiration_date	string or null <date-time> (folder_expiration_date) Example: "2025-11-21T19:45:00Z" Дата и время автоматического удаления в соответствии с ISO 8601. Null означает что автоматическое удаление не происходит.
	Array of objects (attributes) [ 0 .. 250 ] items unique Атрибуты. Используются для указания служебной информации.

Responses

Response Schema: application/json

required	object (folder) Папка - элемент виртуальной файловой системы.
required	Array of objects (folder) [ 0 .. 2001 ] items Список папок.
required	object (table_list_counters) Счетчики по списку.

Request samples

Payload

Content type

application/json

{"parent_key": "11111111-2222-3333-4444-555555555555",
"name": "folder_1",
"comment": "long long long long text",
"color": "red",
"expiration_date": "2025-11-21T19:45:00Z",
"attributes": [ ]
}

Response samples

Content type

application/json

{"folders": [{"key": "2bff0b86-2ddc-445c-9d98-f75ca2eec091",
"parent_key": "65fb88e5-128d-4f3f-9a50-4c2754adcbed",
"name": "My Folder",
"owner_company_key": "veeroute",
"owner_username": "username_1",
"comment": "long text",
"counters": {"folders_count": 0,
"files_count": 3
}
}
],
"counters": {"overall": {"total": 20
},
"filter": {"total": 1
}
}
}

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

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

Authorizations:

ApiKeyAuth

path Parameters

folder_key

required

string <uuid> (unique_key)

Example: 11111111-2222-3333-4444-555555555555

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

Responses

Response samples

Content type

application/json

{"tracedata": {"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": "2025-11-21T09:30:00+03:00"
},
"message": "Bad Request",
"schema_errors": [{"entity": "order_0001",
"message": "bad input data"
}
]
}

Информация о папке

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

Authorizations:

ApiKeyAuth

path Parameters

folder_key

required

string <uuid> (unique_key)

Example: 11111111-2222-3333-4444-555555555555

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

Responses

Response Schema: application/json

parent_key	string or null <uuid> (folder_parent_key) Example: "11111111-2222-3333-4444-555555555555" Ключ родительской папки, `null` если папка корневая.
name required	string (folder_name) [ 1 .. 100 ] characters Example: "folder_1" Название папки.
comment	string or null (folder_comment) [ 0 .. 10000 ] characters Example: "long long long long text" Комментарий к папке.
color	string or null (folder_color) [ 1 .. 20 ] characters Example: "red" Цвет папки.
expiration_date	string or null <date-time> (folder_expiration_date) Example: "2025-11-21T19:45:00Z" Дата и время автоматического удаления в соответствии с ISO 8601. Null означает что автоматическое удаление не происходит.
	Array of objects (attributes) [ 0 .. 250 ] items unique Атрибуты. Используются для указания служебной информации.

Response samples

Content type

application/json

{"parent_key": "11111111-2222-3333-4444-555555555555",
"name": "folder_1",
"comment": "long long long long text",
"color": "red",
"expiration_date": "2025-11-21T19:45:00Z",
"attributes": [ ]
}

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

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

Authorizations:

ApiKeyAuth

path Parameters

folder_key

required

string <uuid> (unique_key)

Example: 11111111-2222-3333-4444-555555555555

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

Responses

Response Schema: application/json

required

Array of objects (folder) [ 0 .. 1000 ] items

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

Response samples

Content type

application/json

{"folders": [{"key": "11111111-2222-3333-4444-555555555555",
"type": "FOLDER",
"parent_key": "11111111-2222-3333-4444-555555555555",
"name": "folder_1",
"comment": "long long long long text",
"color": "red",
"attributes": [ ],
"owner_company_key": "smart_company",
"owner_username": "username_for_login",
"creation_date": "2025-11-21T19:45:00Z",
"expiration_date": "2025-11-21T19:45:00Z",
"counters": {"folders_count": 12,
"files_count": 16
}
}
]
}

Получение ключа папки

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

Authorizations:

ApiKeyAuth

Request Body schema: application/json
required

Запрос на получение ключа папки по пути от корня виртуальной файловой системы. Если любой папки в пути не существует - вернется 404.

Array ([ 0 .. 10 ] items)

string (folder_name) [ 1 .. 100 ] characters

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

Responses

Response Schema: application/json

string <uuid> (unique_key)

Ключ последней папки.

Request samples

Payload

Content type

application/json

["folder_1"
]

Response samples

Content type

application/json

"11111111-2222-3333-4444-555555555555"

Создание папок (пачка)

Создание новых папок (пачка).

Authorizations:

ApiKeyAuth

Request Body schema: application/json
required

Запрос на создание группы папок от корня виртуальной файловой системы. Если любая папка в пути уже существует - она не будет создаваться заново. Метод возвращает ключ последней папки даже в случае, если не было создано ни одной папки.

Array ([ 0 .. 10 ] items)

string (folder_name) [ 1 .. 100 ] characters

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

Responses

Response Schema: application/json

string <uuid> (unique_key)

Ключ последней папки.

Request samples

Payload

Content type

application/json

["folder_1"
]

Response samples

Content type

application/json

"11111111-2222-3333-4444-555555555555"

Удаление папок (пачка)

Массовое удаление папок.

Authorizations:

ApiKeyAuth

Request Body schema: application/json
required

Список ключей папок, которые необходимо удалить.

Array ([ 0 .. 15001 ] items)

string <uuid> (unique_key)

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

Responses

Request samples

Payload

Content type

application/json

["11111111-2222-3333-4444-555555555555"
]

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": "2025-11-21T09:30:00+03:00"
},
"message": "Bad Request",
"schema_errors": [{"entity": "order_0001",
"message": "bad input data"
}
]
}

Получение ключа файла

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

Authorizations:

ApiKeyAuth

Request Body schema: application/json
required

Запрос на получение ключа файла по пути от корня виртуальной файловой системы. Если в папке несколько файлов с одинаковым названием - возвращается последний измененный. Если любой папки или файла в пути не существует - вернется 404.

folder_names required	Array of strings (folder_name_list) [ 0 .. 10 ] items [ items [ 1 .. 100 ] characters ] Example: ["folder_1"] Список названий папок от корня виртуальной файловой системы.
file_name required	string (file_name) [ 1 .. 100 ] characters Example: "file_1" Название файла.

Responses

Response Schema: application/json

string <uuid> (unique_key)

Ключ файла.

Request samples

Payload

Content type

application/json

{"folder_names": ["folder_1"
],
"file_name": "file_1"
}

Response samples

Content type

application/json

"11111111-2222-3333-4444-555555555555"

Удаление файлов (пачка)

Массовое удаление файлов.

Authorizations:

ApiKeyAuth

Request Body schema: application/json
required

Список ключей файлов, которые необходимо удалить.

Array ([ 0 .. 15001 ] items)

string <uuid> (unique_key)

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

Responses

Request samples

Payload

Content type

application/json

["11111111-2222-3333-4444-555555555555"
]

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": "2025-11-21T09:30:00+03:00"
},
"message": "Bad Request",
"schema_errors": [{"entity": "order_0001",
"message": "bad input data"
}
]
}

Счетчики файловой системы

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

Authorizations:

ApiKeyAuth

Responses

Response Schema: application/json

required	object (folder_counters) Текущее количество доступных папок/файлов.
required	object (folder_counters) Максимальное количество доступных папок/файлов.

Response samples

Content type

application/json

{"current": {"folders_count": 12,
"files_count": 16
},
"max": {"folders_count": 12,
"files_count": 16
}
}

Backups

Массовый экспорт и импорт данных.

Экспорт папки

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

Authorizations:

ApiKeyAuth

path Parameters

folder_key

required

string <uuid> (unique_key)

Example: 11111111-2222-3333-4444-555555555555

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

Responses

Response Schema: application/octet-stream

string <byte> (file_zip)

ZIP-архив с данными.

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": "2025-11-21T09:30:00+03:00"
},
"message": "Bad Request",
"schema_errors": [{"entity": "order_0001",
"message": "bad input data"
}
]
}

Импорт папки

Импорт папки с экспериментами. Папка не должна типа ROOT и должна быть пустой.

Authorizations:

ApiKeyAuth

path Parameters

folder_key

required

string <uuid> (unique_key)

Example: 11111111-2222-3333-4444-555555555555

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

Request Body schema: application/octet-stream
required

Данные (ZIP).

string <byte> (file_zip)

ZIP-архив с данными.

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": "2025-11-21T09:30:00+03:00"
},
"message": "Bad Request",
"schema_errors": [{"entity": "order_0001",
"message": "bad input data"
}
]
}

Configurations

Управление файлами конфигураций.

Создание конфигурации

Создание нового файла конфигурации.

Authorizations:

ApiKeyAuth

Request Body schema: application/json
required

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

name required	string (file_name) [ 1 .. 100 ] characters Example: "file_1" Название файла.
comment required	string or null (file_comment) [ 0 .. 10000 ] characters Example: "long long long long text" Комментарий к файлу.
folder_key required	string <uuid> (unique_key) Example: "11111111-2222-3333-4444-555555555555" Ключ папки типа `FOLDER`, в которой находится файл.

Responses

Response Schema: application/json

string <uuid> (unique_key)

Ключ созданного файла конфигурации.

Request samples

Payload

Content type

application/json

{"name": "file_1",
"comment": "long long long long text",
"folder_key": "11111111-2222-3333-4444-555555555555"
}

Response samples

Content type

application/json

"11111111-2222-3333-4444-555555555555"

Чтение конфигурации

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

Authorizations:

ApiKeyAuth

path Parameters

configuration_key

required

string <uuid> (unique_key)

Example: 11111111-2222-3333-4444-555555555555

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

Responses

Response Schema: application/json

key required	string <uuid> (unique_key) Example: "11111111-2222-3333-4444-555555555555" Ключ, уникальный идентификатор.
required	object (file_specification) Спецификация файла.
content required	string (configuration_content) [ 0 .. 2000000 ] characters Example: "{\"long json\"}" Настройки в формате JSON.
json_schema required	string or null (configuration_json_schema) [ 0 .. 2000000 ] characters Example: "{\"$schema\":\"https://json-schema.org/draft/2020-12/schema\", \"type\":\"object\", \"additionalProperties\":true}" Схема для валидации контента (настроек) в формате JSON Schema.
edit_date required	string <date-time> (file_edit_date) Example: "2025-11-21T19:45:00Z" Дата и время последнего редактирования файла в соответствии с ISO 8601.
creation_date required	string <date-time> (file_creation_date) Example: "2025-11-21T19:45:00Z" Дата и время создания файла в соответствии с ISO 8601.

Response samples

Content type

application/json

{"key": "da4e62b0-86cb-4423-b187-5c1a433ca703",
"specification": {"name": "new-cfg-5",
"comment": "just run it",
"folder_key": "2bff0b86-2ddc-445c-9d98-f75ca2ee4091"
},
"content": "{}",
"json_schema": "{'$schema': 'https://json-schema.org/draft/2020-12/schema'}",
"edit_date": "2025-11-15T13:56:07.728Z",
"creation_date": "2025-11-15T13:56:07.728Z"
}

Обновление спецификации

Переименование \ перемещение файла конфигурации.

Authorizations:

ApiKeyAuth

path Parameters

configuration_key

required

string <uuid> (unique_key)

Example: 11111111-2222-3333-4444-555555555555

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

Request Body schema: application/json
required

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

name required	string (file_name) [ 1 .. 100 ] characters Example: "file_1" Название файла.
comment required	string or null (file_comment) [ 0 .. 10000 ] characters Example: "long long long long text" Комментарий к файлу.
folder_key required	string <uuid> (unique_key) Example: "11111111-2222-3333-4444-555555555555" Ключ папки типа `FOLDER`, в которой находится файл.

Responses

Response Schema: application/json

key required	string <uuid> (unique_key) Example: "11111111-2222-3333-4444-555555555555" Ключ, уникальный идентификатор.
required	object (file_specification) Спецификация файла.
content required	string (configuration_content) [ 0 .. 2000000 ] characters Example: "{\"long json\"}" Настройки в формате JSON.
json_schema required	string or null (configuration_json_schema) [ 0 .. 2000000 ] characters Example: "{\"$schema\":\"https://json-schema.org/draft/2020-12/schema\", \"type\":\"object\", \"additionalProperties\":true}" Схема для валидации контента (настроек) в формате JSON Schema.
edit_date required	string <date-time> (file_edit_date) Example: "2025-11-21T19:45:00Z" Дата и время последнего редактирования файла в соответствии с ISO 8601.
creation_date required	string <date-time> (file_creation_date) Example: "2025-11-21T19:45:00Z" Дата и время создания файла в соответствии с ISO 8601.

Request samples

Payload

Content type

application/json

{"name": "file_1",
"comment": "long long long long text",
"folder_key": "11111111-2222-3333-4444-555555555555"
}

Response samples

Content type

application/json

{"key": "da4e62b0-86cb-4423-b187-5c1a433ca703",
"specification": {"name": "new-cfg-5",
"comment": "just run it",
"folder_key": "2bff0b86-2ddc-445c-9d98-f75ca2ee4091"
},
"content": "{}",
"json_schema": "{'$schema': 'https://json-schema.org/draft/2020-12/schema'}",
"edit_date": "2025-11-15T13:56:07.728Z",
"creation_date": "2025-11-15T13:56:07.728Z"
}

Удаление конфигурации

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

Authorizations:

ApiKeyAuth

path Parameters

configuration_key

required

string <uuid> (unique_key)

Example: 11111111-2222-3333-4444-555555555555

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

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": "2025-11-21T09:30:00+03:00"
},
"message": "Bad Request",
"schema_errors": [{"entity": "order_0001",
"message": "bad input data"
}
]
}

Чтение схемы

Чтение схемы.

Authorizations:

ApiKeyAuth

path Parameters

configuration_key

required

string <uuid> (unique_key)

Example: 11111111-2222-3333-4444-555555555555

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

Responses

Response Schema: application/json

string or null (configuration_json_schema) [ 0 .. 2000000 ] characters

Схема для валидации контента (настроек) в формате JSON Schema.

Response samples

Content type

application/json

"{\"$schema\":\"https://json-schema.org/draft/2020-12/schema\", \"type\":\"object\", \"additionalProperties\":true}"

Обновление схемы

Обновление схемы.

Authorizations:

ApiKeyAuth

path Parameters

configuration_key

required

string <uuid> (unique_key)

Example: 11111111-2222-3333-4444-555555555555

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

Request Body schema: application/json
required

Запрос на обновление схемы конфигурации.

string or null (configuration_json_schema) [ 0 .. 2000000 ] characters

Схема для валидации контента (настроек) в формате JSON Schema.

Responses

Request samples

Payload

Content type

application/json

"{\"$schema\":\"https://json-schema.org/draft/2020-12/schema\", \"type\":\"object\", \"additionalProperties\":true}"

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": "2025-11-21T09:30:00+03:00"
},
"message": "Bad Request",
"schema_errors": [{"entity": "order_0001",
"message": "bad input data"
}
]
}

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

Чтение контента.

Authorizations:

ApiKeyAuth

path Parameters

configuration_key

required

string <uuid> (unique_key)

Example: 11111111-2222-3333-4444-555555555555

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

Responses

Response Schema: application/json

string (configuration_content) [ 0 .. 2000000 ] characters

Настройки в формате JSON.

Response samples

Content type

application/json

"{\"long json\"}"

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

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

Authorizations:

ApiKeyAuth

path Parameters

configuration_key

required

string <uuid> (unique_key)

Example: 11111111-2222-3333-4444-555555555555

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

Request Body schema: application/json
required

Запрос на обновление контента конфигурации.

string (configuration_content) [ 0 .. 2000000 ] characters

Настройки в формате JSON.

Responses

Request samples

Payload

Content type

application/json

"{\"long json\"}"

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": "2025-11-21T09:30:00+03:00"
},
"message": "Bad Request",
"schema_errors": [{"entity": "order_0001",
"message": "bad input data"
}
]
}

Список конфигураций (таблица)

Получение списка конфигураций в виде таблицы.

Authorizations:

ApiKeyAuth

query Parameters

folder_key	string <uuid> (unique_key) Example: folder_key=11111111-2222-3333-4444-555555555555 Ключ папки, уникальный идентификатор.
filter	string [ 1 .. 64 ] characters Example: filter=example text Фильтр для поиска по текстовым полям - возвращаются только те файлы, у которых в названии или описании содержится подстрока из фильтра. Если фильтр пустой - возвращаются все файлы в папке. Результат сортируется по времени редактирования.
offset	integer <int32> [ 0 .. 10000000 ] Default: 0 Example: offset=10 Количество пропущенных сущностей до возвращаемого списка.
limit	integer <int32> [ 1 .. 2001 ] Default: 100 Example: limit=10 Максимальное количество возвращаемых сущностей.
sort_field	string (table_configuration_column_type) Default: "SPECIFICATION_NAME" Enum: "ESSENCE_KEY" "CREATION_DATE" "EDIT_DATE" … 3 more Example: sort_field=SPECIFICATION_FOLDER_KEY Название колонки в таблице с конфигурациями.
sort_direction	string Default: "ASC" Enum: "ASC" "DESC" Example: sort_direction=DESC Направление сортировки.

Responses

Response Schema: application/json

required	Array of objects (table_configuration) [ 0 .. 2001 ] items Список конфигураций.
required	object (table_list_counters) Счетчики по списку.

Response samples

Content type

application/json

{"essences": [{"essence_key": "da4e62b0-86cb-4423-b187-5c1a433ca703",
"specification": {"name": "new-cfg-5",
"comment": "just run it",
"folder_key": "2bff0b86-2ddc-445c-9d98-f75ca2ee4091"
},
"edit_date": "2025-11-15T13:56:07.728Z",
"creation_date": "2025-11-15T13:56:07.728Z"
}
],
"counters": {"overall": {"total": 1
},
"filter": {"total": 1
}
}
}

Поиск конфигураций

Глобальный поиск конфигураций по всем вложенным папкам.

Authorizations:

ApiKeyAuth

query Parameters

filter required	string [ 3 .. 128 ] characters Example: filter=example text Фильтр для поиска по текстовым полям - возвращаются только те конфигурации, у которых в названии или описании содержится подстрока из фильтра. Если фильтр пустой - возвращается пустой список. По умолчанию результат сортируется по времени редактирования.
offset	integer <int32> [ 0 .. 10000000 ] Default: 0 Example: offset=10 Количество пропущенных сущностей до возвращаемого списка.
limit	integer <int32> [ 1 .. 2001 ] Default: 100 Example: limit=10 Максимальное количество возвращаемых сущностей.
sort_field	string (table_configuration_column_type) Default: "SPECIFICATION_NAME" Enum: "ESSENCE_KEY" "CREATION_DATE" "EDIT_DATE" … 3 more Example: sort_field=SPECIFICATION_FOLDER_KEY Название колонки в таблице с конфигурациями.
sort_direction	string Default: "ASC" Enum: "ASC" "DESC" Example: sort_direction=DESC Направление сортировки.

Responses

Response Schema: application/json

required	Array of objects (table_configuration) [ 0 .. 2001 ] items Список конфигураций.
required	object (table_list_counters) Счетчики по списку.

Response samples

Content type

application/json

{"essences": [{"essence_key": "da4e62b0-86cb-4423-b187-5c1a433ca703",
"specification": {"name": "new-cfg-5",
"comment": "just run it",
"folder_key": "2bff0b86-2ddc-445c-9d98-f75ca2ee4091"
},
"edit_date": "2025-11-15T13:56:07.728Z",
"creation_date": "2025-11-15T13:56:07.728Z"
}
],
"counters": {"overall": {"total": 1
},
"filter": {"total": 1
}
}
}

Дублирование конфигурации

Дублирование конфигурации.

Authorizations:

ApiKeyAuth

path Parameters

configuration_key

required

string <uuid> (unique_key)

Example: 11111111-2222-3333-4444-555555555555

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

Request Body schema: application/json
required

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

name required	string (file_name) [ 1 .. 100 ] characters Example: "file_1" Название файла.
comment required	string or null (file_comment) [ 0 .. 10000 ] characters Example: "long long long long text" Комментарий к файлу.
folder_key required	string <uuid> (unique_key) Example: "11111111-2222-3333-4444-555555555555" Ключ папки типа `FOLDER`, в которой находится файл.

Responses

Response Schema: application/json

string <uuid> (unique_key)

Ключ продублированной конфигурации.

Request samples

Payload

Content type

application/json

{"name": "file_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"

System

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

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

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

Responses

Response Schema: application/json

health

required

number <double> [ 0 .. 1 ]

Example: "0.999"

Текущий показатель здоровья сервиса.

0.0 означает неготовность сервиса выполнять задачи.
1.0 означает полную готовность сервиса для выполнения задач.

Response samples

200
404
429
500

Content type

application/json

{"health": 0.999
}

Получение версии сервиса

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

Responses

Response Schema: application/json

major required	integer <int32> [ 1 .. 100 ] Example: "7" Версия продукта. В рамках одной версии гарантируется совместимость общих структур данных между сервисами. Изменение версии указывает на несовместимые с предыдущими версиями продукта (и, соответственно, всех сервисов) изменения.
minor required	integer <int32> [ 0 .. 111 ] Example: "15" Минорная версия сервиса. Изменение версии указывает на новую функциональность. Обновление имеет обратную совместимость в рамках мажорной версии сервиса.
build required	string [ 1 .. 64 ] characters Example: "3754RC" Версия сборки. Изменяется при обновлении документации и исправлении ошибок.

Response samples

200
404
429
500

Content type

application/json

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

Получение документации

Получение файла с документацией на этот сервис.

path Parameters

filename

required

string [ 6 .. 128 ] characters

Example: file_en.html

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

Responses

Response Schema:
text/html

string (file_html)

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

Response samples

404
429
500

Content type

application/json

{"resource_key": "resource_key_one",
"detail": "null"
}

VRt.Registry [RG] (7.24.2983)

Описание

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

Explorer

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

Authorizations:

Request Body schema: application/jsonrequired

Responses

Response Schema: application/json

Request samples

Response samples

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

Authorizations:

query Parameters

Responses

Response Schema: application/json

Response samples

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

Authorizations:

path Parameters

Request Body schema: application/jsonrequired

Responses

Response Schema: application/json

Request samples

Response samples

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

Authorizations:

path Parameters

Responses

Response samples

Информация о папке

Authorizations:

path Parameters

Responses

Response Schema: application/json

Response samples

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

Authorizations:

path Parameters

Responses

Response Schema: application/json

Response samples

Получение ключа папки

Authorizations:

Request Body schema: application/jsonrequired

Responses

Response Schema: application/json

Request samples

Response samples

Создание папок (пачка)

Authorizations:

Request Body schema: application/jsonrequired

Responses

Response Schema: application/json

Request samples

Response samples

Удаление папок (пачка)

Authorizations:

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Получение ключа файла

Authorizations:

Request Body schema: application/jsonrequired

Responses

Response Schema: application/json

Request samples

Response samples

Удаление файлов (пачка)

Authorizations:

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Счетчики файловой системы

Authorizations:

Responses

Response Schema: application/json

Response samples

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

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/octet-stream
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