Перейти к содержанию

Протокол

Оглавление

Схема классов

/svg/protos/key/keyapis/telemetry_control/v1/keyapis_telemetry_control_template_v1.proto.svg

keyapis/telemetry_control/v1/keyapis_telemetry_control_template_v1.proto

Сервис предоставляет возможность управлять шаблонами приборов телеметрии

TemplateService

Сервис управления шаблонами приборов телеметрии. Авторизация: - Authorization: Bearer token

Название метода Описание Тип запроса Тип ответа
GetTemplateDevice Метод получения шаблона ПУ. Метод доступен для: Token: service, application, admin, owner, employee, bti, seller. Без учета разрешений keyapis.telemetry_control.v1.GetTemplateDeviceRequest keyapis.telemetry_control.v1.GetTemplateDeviceResponse
GetTemplateDeviceList Метод получения списка шаблонов ПУ. Метод доступен для: Token: service, application, admin, owner, employee, bti, seller. Без учета разрешений keyapis.telemetry_control.v1.GetTemplateDeviceListRequest keyapis.telemetry_control.v1.GetTemplateDeviceListResponse stream
GetTemplateDeviceCount Метод получения количества шаблонов ПУ. Метод доступен для: Token: service, application, admin, owner, employee, bti, seller. Без учета разрешений keyapis.telemetry_control.v1.GetTemplateDeviceCountRequest keyapis.telemetry_control.v1.GetTemplateDeviceCountResponse
PostTemplateDevice Метод сохранения шаблона ПУ. Поддерживает создание и обновление. Метод доступен для: Token: admin, service, application. Без учета разрешений keyapis.telemetry_control.v1.PostTemplateDeviceRequest keyapis.telemetry_control.v1.PostTemplateDeviceResponse
DeleteTemplateDevice Метод удаления шаблона ПУ. Метод доступен для: Token: admin, service, application. Без учета разрешений keyapis.telemetry_control.v1.DeleteTemplateDeviceRequest keyapis.telemetry_control.v1.DeleteTemplateDeviceResponse
GetTemplateIndicator Метод получения шаблона индикатора. Метод доступен для: Token: service, application, admin, owner, employee, bti, seller. Без учета разрешений keyapis.telemetry_control.v1.GetTemplateIndicatorRequest keyapis.telemetry_control.v1.GetTemplateIndicatorResponse
GetTemplateIndicatorList Метод получения списка шаблонов индикаторов. Метод доступен для: Token: service, application, admin, owner, employee, bti, seller. Без учета разрешений keyapis.telemetry_control.v1.GetTemplateIndicatorListRequest keyapis.telemetry_control.v1.GetTemplateIndicatorListResponse stream
GetTemplateIndicatorCount Метод получения количества шаблонов индикаторов. Метод доступен для: Token: service, application, admin, owner, employee, bti, seller. Без учета разрешений keyapis.telemetry_control.v1.GetTemplateIndicatorCountRequest keyapis.telemetry_control.v1.GetTemplateIndicatorCountResponse
PostTemplateIndicator Метод сохранения шаблонов индикатора. Поддерживает создание и обновление. Метод доступен для: Token: admin, service, application. Без учета разрешений keyapis.telemetry_control.v1.PostTemplateIndicatorRequest keyapis.telemetry_control.v1.PostTemplateIndicatorResponse
DeleteTemplateIndicator Метод удаления шаблона шаблона индикатора. Метод доступен для: Token: admin, service, application. Без учета разрешений keyapis.telemetry_control.v1.DeleteTemplateIndicatorRequest keyapis.telemetry_control.v1.DeleteTemplateIndicatorResponse

DeleteTemplateDeviceRequest

Запрос удаления шаблона ПУ

Поле Описание Тип Признак
id Идентификатор int32 REQUIRED

DeleteTemplateDeviceResponse

Ответ на запрос удаления шаблона ПУ

DeleteTemplateIndicatorRequest

Запрос удаления шаблона индикатора

Поле Описание Тип Признак
id Идентификатор int32 REQUIRED

DeleteTemplateIndicatorResponse

Ответ на запрос удаления шаблона индикатора

GetTemplateDeviceCountRequest

Запрос получения количества шаблонов приборов учета

Поле Описание Тип Признак
filter Фильтр по шаблонам приборов учета keyapis.telemetry_control.v1.TemplateDeviceFilter

GetTemplateDeviceCountResponse

Ответ на запрос получения количества шаблонов приборов учета

Поле Описание Тип Признак
data Всего шаблонов приборов учета optional int32
error Ошибка optional keyapis.telemetry_control.v1.GetTemplateDeviceCountResponse.Error

GetTemplateDeviceCountResponse.Error

Ошибка запроса получения количества шаблонов приборов учета

Поле Описание Тип Признак
template_device_filter_validation Ошибка фильтрации optional keyapis.telemetry_control.v1.TemplateDeviceFilter.ValidationError

GetTemplateDeviceListRequest

Запрос получения списка шаблонов ПУ

Поле Описание Тип Признак
filter Фильтр keyapis.telemetry_control.v1.TemplateDeviceFilter
paging Пагинация optional keyapis.telemetry_control.v1.TemplateDevicePaging

GetTemplateDeviceListResponse

Ответ на запрос получения списка шаблонов приборов учета

Поле Описание Тип Признак
data Шаблон ПУ optional keyapis.telemetry_control.v1.TemplateDevice
error Ошибка optional keyapis.telemetry_control.v1.GetTemplateDeviceListResponse.Error

GetTemplateDeviceListResponse.Error

Ошибка запроса получения списка шаблонов приборов учета

Поле Описание Тип Признак
template_device_filter_validation Ошибка фильтрации optional keyapis.telemetry_control.v1.TemplateDeviceFilter.ValidationError
template_device_paging_validation Ошибка пагинации по страницам optional keyapis.telemetry_control.v1.TemplateDevicePaging.ValidationError

GetTemplateDeviceRequest

Запрос получения шаблона ПУ

Поле Описание Тип Признак
id Идентификатор шаблона ПУ int32 REQUIRED

GetTemplateDeviceResponse

Ответ на запрос получения шаблона ПУ

Поле Описание Тип Признак
data Шаблон ПУ optional keyapis.telemetry_control.v1.TemplateDevice

GetTemplateIndicatorCountRequest

Запрос получения количества шаблонов индикаторов

Поле Описание Тип Признак
filter Фильтр по шаблонам индикаторов keyapis.telemetry_control.v1.TemplateIndicatorFilter

GetTemplateIndicatorCountResponse

Ответ на запрос получения количества шаблонов индикаторов

Поле Описание Тип Признак
data Всего шаблонов индикаторов optional int32
error Ошибка optional keyapis.telemetry_control.v1.GetTemplateIndicatorCountResponse.Error

GetTemplateIndicatorCountResponse.Error

Ошибка запроса получения количества шаблонов индикаторов

Поле Описание Тип Признак
template_indicator_filter_validation Ошибка фильтрации optional keyapis.telemetry_control.v1.TemplateIndicatorFilter.ValidationError

GetTemplateIndicatorListRequest

Запрос получения списка шаблонов индикаторов

Поле Описание Тип Признак
filter Фильтр keyapis.telemetry_control.v1.TemplateIndicatorFilter
paging Пагинация optional keyapis.telemetry_control.v1.TemplateIndicatorPaging

GetTemplateIndicatorListResponse

Ответ на запрос получения списка шаблонов индикаторов

Поле Описание Тип Признак
data Шаблон индикатора optional keyapis.telemetry_control.v1.TemplateIndicator
error Ошибка optional keyapis.telemetry_control.v1.GetTemplateIndicatorListResponse.Error

GetTemplateIndicatorListResponse.Error

Ошибка запроса получения списка шаблонов индикаторов

Поле Описание Тип Признак
template_indicator_filter_validation Ошибка фильтрации optional keyapis.telemetry_control.v1.TemplateIndicatorFilter.ValidationError
template_indicator_paging_validation Ошибка пагинации по страницам optional keyapis.telemetry_control.v1.TemplateIndicatorPaging.ValidationError

GetTemplateIndicatorRequest

Запрос получения шаблона шаблона индикатора

Поле Описание Тип Признак
id Идентификатор шаблона индикатора int32 REQUIRED

GetTemplateIndicatorResponse

Ответ на запрос получения шаблона индикатора

Поле Описание Тип Признак
data Шаблон ндикатора optional keyapis.telemetry_control.v1.TemplateIndicator

PostTemplateDeviceRequest

Запрос сохранения шаблона ПУ

Поле Описание Тип Признак
data Шаблон ПУ keyapis.telemetry_control.v1.TemplateDevice REQUIRED

PostTemplateDeviceResponse

Ответ на запрос сохранения шаблона ПУ

Поле Описание Тип Признак
data Шаблон ПУ optional keyapis.telemetry_control.v1.TemplateDevice
error Ошибка optional keyapis.telemetry_control.v1.PostTemplateDeviceResponse.Error

PostTemplateDeviceResponse.Error

Ошибка запроса сохранения шаблона ПУ

Поле Описание Тип Признак
validation Ошибка валидации optional keyapis.telemetry_control.v1.TemplateDevice.ValidationError

PostTemplateIndicatorRequest

Запрос сохранения шаблона индикатора

Поле Описание Тип Признак
data Шаблон индикатора keyapis.telemetry_control.v1.TemplateIndicator REQUIRED

PostTemplateIndicatorResponse

Ответ на запрос сохранения шаблона индикатора

Поле Описание Тип Признак
data Шаблон индикатора optional keyapis.telemetry_control.v1.TemplateIndicator
error Ошибка optional keyapis.telemetry_control.v1.PostTemplateIndicatorResponse.Error

PostTemplateIndicatorResponse.Error

Ошибка запроса сохранения шаблона индикатора

Поле Описание Тип Признак
validation Ошибка валидации optional keyapis.telemetry_control.v1.TemplateIndicator.ValidationError

TemplateDevice

Шаблон ПУ

Поле Описание Тип Признак
id Идентификатор int32
created_at Дата создания google.protobuf.Timestamp OUTPUT_ONLY
changed_at Дата последнего изменения. Заполняется и обновляется сервером. Заполняется при создании и изменении google.protobuf.Timestamp OUTPUT_ONLY
metric_type Тип энергоресурса keyapis.telemetry_control.v1.TemplateDevice.MetricType REQUIRED
model_id ID Модели счетчика int32
indicator_template_ids Шаблоны индикаторов repeated int32
plan_type Тип тарифного плана. Для ПУ электроэнергии keyapis.telemetry_control.v1.TemplateDevice.PlanType
indicator_vendor_type Посредник получения показаний keyapis.telemetry_control.v1.TemplateIndicator.VendorType

TemplateDevice.ValidationError

Ошибки валидации. Эти проверки выполняются до обращения в базу данных

Поле Описание Тип Признак
path Путь к полю в формате наименования protobuf string REQUIRED
message Валидационное сообщение string REQUIRED

TemplateDeviceFilter

Фильтр для запроса шаблонов приборов учета. При передаче массива в параметр фильтра элементы массива работают в выборке через ИЛИ. При передаче нескольких разных параметров фильтра они работают в выборке через И

Поле Описание Тип Признак
metric_types По типу энергоресурса repeated keyapis.telemetry_control.v1.TemplateDevice.MetricType
model_ids По ID модели счетчика repeated int32
plan_types По типу тарифного плана. Для ПУ электроэнергии repeated keyapis.telemetry_control.v1.TemplateDevice.PlanType
indicator_vendor_types По посреднику получения показаний repeated keyapis.telemetry_control.v1.TemplateIndicator.VendorType

TemplateDeviceFilter.ValidationError

Ошибки валидации. Эти проверки выполняются до обращения в базу данных

Поле Описание Тип Признак
path Путь к полю в формате наименования protobuf string REQUIRED
message Валидационное сообщение string REQUIRED

TemplateDevicePaging

Пагинация

Поле Описание Тип Признак
order_by_type Тип значения сортировки. По умолчанию: ID keyapis.telemetry_control.v1.TemplateDevicePaging.OrderByType
direction_type Тип направления сортировки. По умолчанию: DESC keyapis.telemetry_control.v1.TemplateDevicePaging.DirectionType
limit Количество. Минимальное значение: 1. Максимальное значение: 100. По умолчанию: 20. Если значение 0 (не передано) то выставляем значение по умолчанию int32
offset Сдвиг. По умолчанию: 0 int32

TemplateDevicePaging.ValidationError

Ошибка валидации постраничной пагинации по шаблонам ПУ. Эти проверки выполняются до обращения в базу данных

Поле Описание Тип Признак
limit Количество передано некорректно optional keyapis.telemetry_control.v1.TemplateDevicePaging.ValidationError.LimitInvalid
offset Сдвиг передан некорректно optional keyapis.telemetry_control.v1.TemplateDevicePaging.ValidationError.OffsetInvalid

TemplateDevicePaging.ValidationError.LimitInvalid

Причины: - Значение количества < 0 или > 100

TemplateDevicePaging.ValidationError.OffsetInvalid

Причины: - Значение сдвига < 0

TemplateIndicator

Шаблон индикатора

Поле Описание Тип Признак
id Идентификатор int32
created_at Дата создания google.protobuf.Timestamp OUTPUT_ONLY
changed_at Дата последнего изменения. Заполняется и обновляется сервером. Заполняется при создании и изменении google.protobuf.Timestamp OUTPUT_ONLY
title Шаблонное название индикатора string REQUIRED
unit_type Тип единицы измерения, в которой интерпретировано, получаемое измерение keyapis.telemetry_control.v1.TemplateIndicator.UnitType REQUIRED
sign_type Тип измерения keyapis.telemetry_control.v1.TemplateIndicator.SignType REQUIRED
archive_type Тип архивности показаний keyapis.telemetry_control.v1.TemplateIndicator.ArchiveType
presentation_unit_type Тип единицы измерения для отображения измерения. При UNIT_TYPE_UNKNOWN отображаемые единицы совпадают с единицами источников значений, преобразования единиц не происходит. Применяется после коэффициента keyapis.telemetry_control.v1.TemplateIndicator.UnitType
compatibility_code Код для совместимости с поставщиком метрик google.protobuf.StringValue
is_individual Флаг видимости индикатора для клиента ФЛ bool
coefficient Коэффициент, на который умножается отображаемое значение. Применяется перед преобразованием единиц измерений к presentation_unit_type и после применения поправки google.protobuf.FloatValue
shift Величина поправки к отображаемому значению. Применяется перед применением коэффициента google.protobuf.FloatValue
round_decimal_digits Количество возвращаемых десятичных знаков при округлении итогового значения. При пустом параметре округления не происходит. Применяется после преобразования единиц измерения google.protobuf.Int32Value
metric_expected_freq Ожидаемая частота поступления показаний в днях int32
indicator_vendor_type Посредник получения показаний keyapis.telemetry_control.v1.TemplateIndicator.VendorType

TemplateIndicator.ValidationError

Ошибки валидации. Эти проверки выполняются до обращения в базу данных

Поле Описание Тип Признак
path Путь к полю в формате наименования protobuf string REQUIRED
message Валидационное сообщение string REQUIRED

TemplateIndicatorFilter

Фильтр для запроса шаблонов индикаторов. При передаче массива в параметр фильтра элементы массива работают в выборке через ИЛИ. При передаче нескольких разных параметров фильтра они работают в выборке через И

Поле Описание Тип Признак
sign_types По типу измерений repeated keyapis.telemetry_control.v1.TemplateIndicator.SignType
archive_types По типу архивности показаний repeated keyapis.telemetry_control.v1.TemplateIndicator.ArchiveType
is_individual По флагу видимости индикатора для клиента ФЛ google.protobuf.BoolValue
title По шаблонному названию индикатора. Поиск производится по подстроке google.protobuf.StringValue
indicator_vendor_types По посреднику получения показаний repeated keyapis.telemetry_control.v1.TemplateIndicator.VendorType

TemplateIndicatorFilter.ValidationError

Ошибки валидации. Эти проверки выполняются до обращения в базу данных

Поле Описание Тип Признак
path Путь к полю в формате наименования protobuf string REQUIRED
message Валидационное сообщение string REQUIRED

TemplateIndicatorPaging

Пагинация

Поле Описание Тип Признак
order_by_type Тип значения сортировки. По умолчанию: ID keyapis.telemetry_control.v1.TemplateIndicatorPaging.OrderByType
direction_type Тип направления сортировки. По умолчанию: DESC keyapis.telemetry_control.v1.TemplateIndicatorPaging.DirectionType
limit Количество. Минимальное значение: 1. Максимальное значение: 100. По умолчанию: 20. Если значение 0 (не передано) то выставляем значение по умолчанию int32
offset Сдвиг. По умолчанию: 0 int32

TemplateIndicatorPaging.ValidationError

Ошибка валидации постраничной пагинации по шаблонам индикатора. Эти проверки выполняются до обращения в базу данных

Поле Описание Тип Признак
limit Количество передано некорректно optional keyapis.telemetry_control.v1.TemplateIndicatorPaging.ValidationError.LimitInvalid
offset Сдвиг передан некорректно optional keyapis.telemetry_control.v1.TemplateIndicatorPaging.ValidationError.OffsetInvalid

TemplateIndicatorPaging.ValidationError.LimitInvalid

Причины: - Значение количества < 0 или > 100

TemplateIndicatorPaging.ValidationError.OffsetInvalid

Причины: - Значение сдвига < 0

TemplateDevice.MetricType

Справочние типов энергоресурсов

Номер Тип Название
0 METRIC_TYPE_UNKNOWN Значение не указано
1 HOT_WATER Горячая вода
2 COLD_WATER Холодная вода
3 HEAT Теплоэнергия
4 GAS Газ
5 ELECTRICITY Электроэнергия

TemplateDevice.PlanType

Тип тарифного плана

Номер Тип Название
0 PLAN_TYPE_UNKNOWN Значение не указано
1 SINGLE Однотарифный
2 DOUBLE Двухтарифный
3 TRIPLE Трёхтарифный

TemplateDevicePaging.DirectionType

Справочник типов направлений сортировки

Номер Тип Название
0 DIRECTION_TYPE_UNKNOWN Значение не указано
1 DESC От большего к меньшему
2 ASC От меньшего к большему

TemplateDevicePaging.OrderByType

Справочник типов значений сортировки

Номер Тип Название
0 ORDER_BY_TYPE_UNKNOWN Значение не указано
1 ID По идентификатору
2 METRIC_TYPE По типу энергоресурса
3 MODEL По модели счетчика

TemplateIndicator.ArchiveType

Справочник типа архивности показаний. Используется для указания за какой период произошло измерение. По умолчанию CURRENT

Номер Тип Название
0 ARCHIVE_TYPE_UNKNOWN Значение не указано
1 CURRENT Текущие показания
2 HALFHOUR За 30 мин
3 HOUR За час
4 DAY За суток
5 MONTH За месяц
6 YEAR За год

TemplateIndicator.SignType

Справочник типов измерений

Номер Тип Название
0 SIGN_TYPE_UNKNOWN Значение не указано
1 ABSOLUTE_DS Абсолютный показатель
2 ABSOLUTE_RC Абсолютный расход ресурса
3 INTERVAL_DS Интервальный показатель состояния
4 INTERVAL_RC Интервальный расход ресурса
5 CURRENT_DS Текущее состояние
6 CURRENT_RS Текущее состояние ресурса
7 VOLUME Объём
8 PARAMETER Параметр конфигурации
9 FLAG Флаг состояния

TemplateIndicator.UnitType

Справочник типов единиц измерений

Номер Тип Название
0 UNIT_TYPE_UNKNOWN Значение не указано
1 PERCENT Процент
2 C Градус по Цельсию
3 WT Ватт
4 GKAL Гигакалория
5 VALUE Количество
6 KWH Киловaтт-час
7 KG_CM2 Килограмм на квадратный сантиметр
8 KGF_CM2 Килограмм-сила на квадратный сантиметр
9 M3 Кубический метр
10 M3_H Кубический метр в час
11 MPA Мегапаскаль
12 MS Миллисекунда
13 BOOLEAN Флаг состояния
14 T Тонна
15 T_H Тонна в час
16 H Час
17 NON_MEASURABLE Безразмерная величина
18 IMP Импульс
19 J Джоуль
20 KJ Килоджоуль
21 GJ Гигаджоуль
22 WTH Ватт-час
23 KWT Киловатт
24 MIN Минута
25 S Секунда

TemplateIndicator.VendorType

Посредники получения показаний

Номер Тип Название
0 VENDOR_TYPE_UNKNOWN Значение не указано
1 ENVIRO Энвайро
2 LARTECH Лартех
3 RTK РТК

TemplateIndicatorPaging.DirectionType

Справочник типов направлений сортировки

Номер Тип Название
0 DIRECTION_TYPE_UNKNOWN Значение не указано
1 DESC От большего к меньшему
2 ASC От меньшего к большему

TemplateIndicatorPaging.OrderByType

Справочник типов значений сортировки

Номер Тип Название
0 ORDER_BY_TYPE_UNKNOWN Значение не указано
1 ID По идентификатору
2 SIGN_TYPE По типу измерений
3 ARCHIVE_TYPE По типу архивности показаний

Скалярные типы значений

.proto Type Примечание Python Go Ruby C# C++ Java PHP
double float float64 Float double double double float
float float float32 Float float float float float
int32 Uses variable-length encoding. Inefficient for encoding negative numbers – if your field is likely to have negative values, use sint32 instead. int int32 Bignum or Fixnum (as required) int int32 int integer
int64 Uses variable-length encoding. Inefficient for encoding negative numbers – if your field is likely to have negative values, use sint64 instead. int/long int64 Bignum long int64 long integer/string
uint32 Uses variable-length encoding. int/long uint32 Bignum or Fixnum (as required) uint uint32 int integer
uint64 Uses variable-length encoding. int/long uint64 Bignum or Fixnum (as required) ulong uint64 long integer/string
sint32 Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int32s. int int32 Bignum or Fixnum (as required) int int32 int integer
sint64 Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int64s. int/long int64 Bignum long int64 long integer/string
fixed32 Always four bytes. More efficient than uint32 if values are often greater than 2^28. int uint32 Bignum or Fixnum (as required) uint uint32 int integer
fixed64 Always eight bytes. More efficient than uint64 if values are often greater than 2^56. int/long uint64 Bignum ulong uint64 long integer/string
sfixed32 Always four bytes. int int32 Bignum or Fixnum (as required) int int32 int integer
sfixed64 Always eight bytes. int/long int64 Bignum long int64 long integer/string
bool boolean bool TrueClass/FalseClass bool bool boolean boolean
string A string must always contain UTF-8 encoded or 7-bit ASCII text. str/unicode string String (UTF-8) string string String string
bytes May contain any arbitrary sequence of bytes. str []byte String (ASCII-8BIT) ByteString string ByteString string