Протокол¶
Оглавление¶
-
keyapis/telemetry_control/v1/keyapis_telemetry_control_dictionary_v1.proto
- DeleteDictionaryDeviceModelResponse
- DictionaryDeviceModel
- DictionaryDeviceModelFilter
- DictionaryDeviceModelPaging
- DictionaryMrf
- DictionaryPermission
- DictionaryRf
- GetDictionaryDeviceModelCountRequest
- GetDictionaryDeviceModelCountResponse
- GetDictionaryDeviceModelListRequest
- GetDictionaryDeviceModelListResponse
- GetDictionaryDeviceModelRequest
- GetDictionaryDeviceModelResponse
- GetDictionaryMrfCountRequest
- GetDictionaryMrfCountResponse
- GetDictionaryMrfListRequest
- GetDictionaryMrfListResponse
- GetDictionaryRfCountRequest
- GetDictionaryRfCountResponse
- GetDictionaryRfListRequest
- GetDictionaryRfListResponse
- PostDictionaryDeviceModelRequest
- DictionaryDeviceModelPaging.OrderByType
- DictionaryMrf.MrfType
- DictionaryPermission.PermissionType
- DictionaryRf.RfType
Схема классов¶
keyapis/telemetry_control/v1/keyapis_telemetry_control_dictionary_v1.proto¶
Сервис предоставляет возможность управлять справочниками телеметрии
DictionaryService¶
Сервис управления справочниками телеметрии. Авторизация: - Authorization: Bearer token
| Название метода | Описание | Тип запроса | Тип ответа |
|---|---|---|---|
| GetDictionaryDeviceModelList | Метод получения списка моделей ПУ. Метод доступен для: Token: admin, service, application, bti, owner, employee, seller. Без учета разрешений | keyapis.telemetry_control.v1.GetDictionaryDeviceModelListRequest | keyapis.telemetry_control.v1.GetDictionaryDeviceModelListResponse stream |
| GetDictionaryDeviceModelCount | Метод получения количества моделей ПУ. Метод доступен для: Token: admin, service, application, bti, owner, employee, seller. Без учета разрешений | keyapis.telemetry_control.v1.GetDictionaryDeviceModelCountRequest | keyapis.telemetry_control.v1.GetDictionaryDeviceModelCountResponse |
| PostDictionaryDeviceModel | Метод сохранения модели ПУ. Поддерживает создание и обновление. Метод доступен для: Token: admin, service, application. Без учета разрешений | keyapis.telemetry_control.v1.PostDictionaryDeviceModelRequest | keyapis.telemetry_control.v1.PostDictionaryDeviceModelResponse |
| DeleteDictionaryDeviceModel | Метод удаления модели ПУ. Метод доступен для: Token: admin, service, application. Без учета разрешений | keyapis.telemetry_control.v1.DeleteDictionaryDeviceModelRequest | keyapis.telemetry_control.v1.DeleteDictionaryDeviceModelResponse |
| GetDictionaryMrfList | Метод получения списка элементов справочника Макрорегионы (МРФ). Метод доступен для: Token: admin, service, application, bti, owner, employee, seller. Без учета разрешений | keyapis.telemetry_control.v1.GetDictionaryMrfListRequest | keyapis.telemetry_control.v1.GetDictionaryMrfListResponse stream |
| GetDictionaryMrfCount | Метод получения количества элементов справочника Макрорегионы (МРФ). Метод доступен для: Token: admin, service, application, bti, owner, employee, seller. Без учета разрешений | keyapis.telemetry_control.v1.GetDictionaryMrfCountRequest | keyapis.telemetry_control.v1.GetDictionaryMrfCountResponse |
| GetDictionaryRfList | Метод получения списка элементов справочника Регионы (РФ). Метод доступен для: Token: admin, service, application, bti, owner, employee, seller. Без учета разрешений | keyapis.telemetry_control.v1.GetDictionaryRfListRequest | keyapis.telemetry_control.v1.GetDictionaryRfListResponse stream |
| GetDictionaryRfCount | Метод получения количества элементов справочника Регионы (РФ). Метод доступен для: Token: admin, service, application, bti, owner, employee, seller. Без учета разрешений | keyapis.telemetry_control.v1.GetDictionaryRfCountRequest | keyapis.telemetry_control.v1.GetDictionaryRfCountResponse |
DeleteDictionaryDeviceModelRequest¶
Запрос удаления модели ПУ
| Поле | Описание | Тип | Признак |
|---|---|---|---|
| id | Идентификатор | int32 | REQUIRED |
DeleteDictionaryDeviceModelResponse¶
Ответ на запрос удаления модели ПУ
DictionaryDeviceModel¶
Элемент справочника моделей ПУ
| Поле | Описание | Тип | Признак |
|---|---|---|---|
| id | Идентификатор | int32 | |
| created_at | Дата создания | google.protobuf.Timestamp | OUTPUT_ONLY |
| changed_at | Дата последнего изменения. Заполняется и обновляется сервером. Заполняется при создании и изменении | google.protobuf.Timestamp | OUTPUT_ONLY |
| title | Модель счетчика | google.protobuf.StringValue | |
| protocol | Протокол счетчика | google.protobuf.StringValue | |
| model_kind | Тип модели | google.protobuf.StringValue |
DictionaryDeviceModelFilter¶
Фильтр для запроса моделей приборов учета. При передаче массива в параметр фильтра элементы массива работают в выборке через ИЛИ. При передаче нескольких разных параметров фильтра они работают в выборке через И
| Поле | Описание | Тип | Признак |
|---|---|---|---|
| titles | По заголовку элемента | repeated string | |
| model_kinds | По типам модели | repeated string |
DictionaryDeviceModelPaging¶
Пагинация
| Поле | Описание | Тип | Признак |
|---|---|---|---|
| order_by_type | Тип значения сортировки. По умолчанию: ID | keyapis.telemetry_control.v1.DictionaryDeviceModelPaging.OrderByType | |
| direction_type | Тип направления сортировки. По умолчанию: DESC | keyapis.telemetry_control.v1.DictionaryDeviceModelPaging.DirectionType | |
| limit | Количество. Минимальное значение: 1. Максимальное значение: 100. По умолчанию: 20. Если значение 0 (не передано) то выставляем значение по умолчанию | int32 | |
| offset | Сдвиг. По умолчанию: 0 | int32 |
DictionaryMrf¶
Элемент справочника Макрорегионы (МРФ)
| Поле | Описание | Тип | Признак |
|---|---|---|---|
| id | Идентификатор | int32 | OUTPUT_ONLY |
| created_at | Дата создания | google.protobuf.Timestamp | OUTPUT_ONLY |
| changed_at | Дата последнего изменения. Заполняется и обновляется сервером. Заполняется при создании и изменении | google.protobuf.Timestamp | OUTPUT_ONLY |
| title | Локализованный заголовок элемента | google.protobuf.StringValue | |
| code | Техническое наименование элемента | google.protobuf.StringValue |
DictionaryPermission¶
Элемент справочника Разрешения Телеметрии
| Поле | Описание | Тип | Признак |
|---|---|---|---|
| permission_type | Элемент справочника Разрешения Телеметрии | keyapis.telemetry_control.v1.DictionaryPermission.PermissionType |
DictionaryRf¶
Элемент справочника Регионы (РФ)
| Поле | Описание | Тип | Признак |
|---|---|---|---|
| id | Идентификатор | int32 | OUTPUT_ONLY |
| created_at | Дата создания | google.protobuf.Timestamp | OUTPUT_ONLY |
| changed_at | Дата последнего изменения. Заполняется и обновляется сервером. Заполняется при создании и изменении | google.protobuf.Timestamp | OUTPUT_ONLY |
| title | Локализованный заголовок элемента | google.protobuf.StringValue | |
| code | Техническое наименование элемента | google.protobuf.StringValue | |
| mrf_id | Принадлежность региона к Макрорегиону (МРФ) | int32 | REQUIRED |
GetDictionaryDeviceModelCountRequest¶
Запрос получения количества моделей приборов учета
| Поле | Описание | Тип | Признак |
|---|---|---|---|
| filter | Фильтр по моделям приборов учета | keyapis.telemetry_control.v1.DictionaryDeviceModelFilter |
GetDictionaryDeviceModelCountResponse¶
Ответ на запрос получения количества моделей приборов учета
| Поле | Описание | Тип | Признак |
|---|---|---|---|
| data | Всего моделей приборов учета | optional int32 |
GetDictionaryDeviceModelListRequest¶
Запрос получения списка моделей ПУ
| Поле | Описание | Тип | Признак |
|---|---|---|---|
| filter | Фильтр | keyapis.telemetry_control.v1.DictionaryDeviceModelFilter | |
| paging | Пагинация | optional keyapis.telemetry_control.v1.DictionaryDeviceModelPaging |
GetDictionaryDeviceModelListResponse¶
Ответ на запрос получения списка моделей приборов учета
| Поле | Описание | Тип | Признак |
|---|---|---|---|
| data | Элемент справочника моделей ПУ | optional keyapis.telemetry_control.v1.DictionaryDeviceModel |
GetDictionaryDeviceModelRequest¶
Запрос получения модели ПУ
| Поле | Описание | Тип | Признак |
|---|---|---|---|
| id | Идентификатор модели ПУ | int32 | REQUIRED |
GetDictionaryDeviceModelResponse¶
Ответ на запрос получения модели ПУ
| Поле | Описание | Тип | Признак |
|---|---|---|---|
| data | Элемент справочника моделей | optional keyapis.telemetry_control.v1.DictionaryDeviceModel |
GetDictionaryMrfCountRequest¶
Запрос получения количества элементов справочника Макрорегионы (МРФ)
GetDictionaryMrfCountResponse¶
Ответ на запрос получения количества элементов справочника Макрорегионы (МРФ)
| Поле | Описание | Тип | Признак |
|---|---|---|---|
| data | Всего элементов справочника Макрорегионы (МРФ) | optional int32 |
GetDictionaryMrfListRequest¶
Запрос получения элементов справочника Макрорегионы (МРФ)
GetDictionaryMrfListResponse¶
Ответ на запрос получения элементов справочника Макрорегионы (МРФ)
| Поле | Описание | Тип | Признак |
|---|---|---|---|
| data | Элемент справочника Макрорегионы (МРФ) | optional keyapis.telemetry_control.v1.DictionaryMrf |
GetDictionaryRfCountRequest¶
Запрос получения количества элементов справочника Регионы (РФ)
GetDictionaryRfCountResponse¶
Ответ на запрос получения количества элементов справочника Регионы (РФ)
| Поле | Описание | Тип | Признак |
|---|---|---|---|
| data | Всего элементов справочника Регионы (РФ) | optional int32 |
GetDictionaryRfListRequest¶
Запрос получения элементов справочника Регионы (РФ)
GetDictionaryRfListResponse¶
Ответ на запрос получения элементов справочника Регионы (РФ)
| Поле | Описание | Тип | Признак |
|---|---|---|---|
| data | Элемент справочника Регионы (РФ) | optional keyapis.telemetry_control.v1.DictionaryRf |
PostDictionaryDeviceModelRequest¶
Запрос сохранения модели ПУ
| Поле | Описание | Тип | Признак |
|---|---|---|---|
| data | Шаблон ПУ | keyapis.telemetry_control.v1.DictionaryDeviceModel | REQUIRED |
PostDictionaryDeviceModelResponse¶
Ответ на запрос сохранения модели ПУ
| Поле | Описание | Тип | Признак |
|---|---|---|---|
| data | Шаблон ПУ | optional keyapis.telemetry_control.v1.DictionaryDeviceModel |
DictionaryDeviceModelPaging.DirectionType¶
Справочник типов направлений сортировки. По умолчанию: ASC
| Номер | Тип | Название |
|---|---|---|
| 0 | DIRECTION_TYPE_UNKNOWN | Значение не указано |
| 1 | DESC | От большего к меньшему |
| 2 | ASC | От меньшего к большему |
DictionaryDeviceModelPaging.OrderByType¶
Справочник типов значений сортировки
| Номер | Тип | Название |
|---|---|---|
| 0 | ORDER_BY_TYPE_UNKNOWN | Значение не указано |
| 1 | ID | По идентификатору |
| 2 | TITLE | По заголовку элемента |
DictionaryMrf.MrfType¶
Справочник Макрорегионы (МРФ)
| Номер | Тип | Название |
|---|---|---|
| 0 | MRF_TYPE_UNKNOWN | Значение не указано |
| 1 | TSENTR | Центр |
| 2 | YUG | Юг |
| 3 | URAL | Урал |
| 4 | SIBIR | Сибирь |
| 5 | SEVERO_ZAPAD | Северо-Запад |
| 6 | DALNIY_VOSTOK | Дальний Восток |
| 7 | VOLGA | Волга |
DictionaryPermission.PermissionType¶
Справочник Разрешения Телеметрии
| Номер | Тип | Название |
|---|---|---|
| 0 | PERMISSION_TYPE_UNKNOWN | Значение не указано |
DictionaryRf.RfType¶
Справочник Регионы (РФ)
| Номер | Тип | Название |
|---|---|---|
| 0 | RF_TYPE_UNKNOWN | Значение не указано |
| 1 | UFA | Республика Башкортостан |
| 2 | KIROV | Кировская область |
| 3 | IVANOVO | Ивановский филиал |
| 4 | KALUGA | Калужский филиал |
| 5 | KOSTROMA | Костромской филиал |
| 6 | KURSK | Курский филиал |
| 7 | LIPETSK | Липецкий филиал |
| 8 | MOSOBLAST | Московская область |
| 9 | OREL | Орловский филиал |
| 10 | RYAZAN | Рязанский филиал |
| 11 | TAMBOV | Тамбовский филиал |
| 12 | TVER | Тверской филиал |
| 13 | YAROSLAVL | Ярославский филиал |
| 14 | SMOLENSK | Смоленский филиал |
| 15 | TULA | Тульский филиал |
| 16 | MOSCOW | Москва |
| 17 | EAO | ЕАО |
| 18 | KURGAN | Филиал в Тюменской и Курганской областях |
| 19 | TUMEN | Филиал в Тюменской и Курганской областях |
| 20 | HANTY | Ханты-Мансийский филиал |
| 21 | AMUR | Амурская область |
| 22 | KAMCHATKA | Камчатский край |
| 23 | MAGADAN | Магаданская область |
| 24 | PRIMORYE | Приморский край |
| 25 | SAKHALIN | Сахалинская область |
| 26 | KHABAROVSK | Хабаровский край |
| 27 | CHITA | Забайкальский край |
| 28 | CHUKOTKA | ЧАО |
| 29 | ARCHANGELSK | Архангельск |
| 30 | VOLOGDA | Вологда |
| 31 | KALININGRAD | Калининград |
| 32 | KARELIA | Карелия |
| 33 | KOMI | Коми |
| 34 | LENOBLAST | Лен область |
| 35 | MURMANSK | Мурманск |
| 36 | NOVGOROD | Новгород |
| 37 | PSKOV | Псков |
| 38 | SPB | СПб |
| 39 | ALTAI | Алтайский филиал |
| 40 | BURYATIYA | Бурятский филиал |
| 41 | IRKUTSK | Иркутский филиал |
| 42 | KEMEROVO | Кемеровский филиал |
| 43 | KRASNOYARSK | Красноярский филиал |
| 44 | OMSK | Омский филиал |
| 45 | HAKASIYA | Республика Хакасия |
| 46 | RALTAY | Республика Алтай |
| 47 | TUVA | Республика Тыва |
| 48 | TOMSK | Томский филиал |
| 49 | ORENBURG | Оренбургская область |
| 50 | BELGOROD | Белгородский филиал |
| 51 | SAKHA | Саха |
| 52 | EKT | Екатеринбургский филиал |
| 53 | VOLGOGRAD | Волгоградский филиал |
| 54 | YAMAL | Ямало-Ненецкий филиал |
| 55 | CHELYABINSK | Челябинский филиал |
| 56 | PERM | Пермский филиал ПАО "Ростелеком" |
| 57 | MARYEL | Республика Марий Эл |
| 58 | PENZA | Пензенская область |
| 59 | INGUSHETIA | Ингушский филиал |
| 60 | NALCHIK | Кабардино-Балкарский филиал |
| 61 | ELISTA | Калмыцкий филиал |
| 62 | ROSTOV | Ростовский филиал |
| 63 | MAHACHKALA | Дагестанский филиал |
| 64 | MORDOVIYA | Республика Мордовия |
| 65 | KAZAN | Республика Татарстан (Татарстан) |
| 66 | SAMARA | Самарская область |
| 67 | SARATOV | Саратовская область |
| 68 | UDMURTIYA | Удмуртская Республика |
| 69 | ULYANOVSK | Ульяновская область |
| 70 | CHUVASHIYA | Чувашская Республика - Чувашия |
| 71 | NNOVGOROD | Нижегородская область |
| 72 | BRYANSK | Брянский филиал |
| 73 | VLADIMIR | Владимирский филиал |
| 74 | VORONEZH | Воронежский филиал |
| 75 | VLADIKAVKAZ | Северо-Осетинский филиал |
| 76 | STAVROPOL | Ставропольский филиал |
| 77 | CHERKESSK | Республика Карачаево-Черкесская |
| 78 | MAYKOP | Республика Адыгея |
| 79 | ASTRAKHAN | Астраханский филиал |
| 80 | KRASNODAR | Краснодарский филиал |
| 81 | TEST | Тестовый |
| 82 | NOVOSIBIRSK | Новосибирский филиал |
Скалярные типы значений¶
| .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 |