IncrementUpdateFieldFactDesc
Описание параметров
Имя | Описание | Пример | |
---|---|---|---|
CubeDesc | параметры мультисферы | ||
"uuid": string, | идентификатор мультисферы | "uuid" : "8c9c31b6", | |
"name": string, | имя мультисферы | "name" : "ms_for_test", | |
"creator": string, | логин пользователя, создавшего мультисферу | "creator" : "user", | |
"row_count": uint32_t, | количество строк данных | "row_count" : 581265, | |
"dimension_count": uint32_t, | количество размерностей | "dimension_count" : 20, | |
"fact_count": uint32_t, | количество фактов | "fact_count" : 5, | |
"size" : size_t, | размер мультисферы в байтах | "size" : 79207130, | |
"creation_time": Timestamp, | время создания в микросекундах | "creation_time" : 1519644043801520, | |
"update_time": Timestamp, | время обновления в микросекундах | "update_time" : 1566914647978842, | |
"last_use_time": Timestamp, | время последнего обращения в микросекундах | "last_use_time" : 1536939399496365, | |
"available": bool, | доступность для пользователя | "available" : true, | |
"is_updated": bool, | обновлялась сфера или нет | "is_updated" : false, | |
"ready_percent": float, | завершенность импорта в % | "ready_percent" : 100, | |
"update_error": bool, | возникли ли ошибки при обновлении или нет | "update_error" : false, | |
"exclusive_ownership" : bool | мультисфера доступна только одному пользователю
| "exclusive_ownership" : false | |
"update_started_at": Timestamp | Время последнего начала обновления данных куба через механизм обновления | "update_started_at": 1566914647978842 | |
"can_be_updated": bool | Признак возможности обновления мультисферы (источник не из файла) | "can_be_updated": true | |
"opened_count": int | Общее количество открытий | "opened_count": 10 | |
DataSourceDesc | параметры источника данных | ||
"database": string, | имя базы данных | "database" : "", | |
"encoding": string, | кодировка, используется для источников типа csv | "encoding" : "", | |
"fields": [FieldDesc], | строки импортируемых данных | ||
идентификатор поля | "id" : "bdc9dd55", | ||
имя поля | "name" : "Дата", | ||
тип данных OlapDataType: | "type" : 8, | ||
FIELD_MARK_COMMON - 0 FIELD_MARK_CREATED - 1 FIELD_MARK_DELETED - 2 | "mark" : 0 | ||
"id": string, | идентификатор источника данных | "id" : "788e6744", | |
"name": string, | имя источника данных | "name" : "", | |
"login": string, | логин для подключения к источнику данных | "login" : "login", | |
"passwd": string, | пароль для подключения к источнику данных | "passwd" : "pass", | |
"server": string, | сервер источника | "server" : "10.10.10.10", | |
"server_type": DataSourceType, | Типы источников данных: "none" : 0, | "server_type" : 5, | |
"skip": int, | указатель на строку заголовка, используется для источников типа csv. -1 по умолчанию - определяем строку заголовка за пользователя | "skip" : -1, | |
"sql_query": string, | запрос к БД | "sql_query" : "SELECT [Товар], [Кол_во] FROM [CUBES].[dbo].[ms_for_test]", | |
"status": PlmError | статус выполнения | "status" : {"code" : 0} | |
код сообщения | "code" : 310 | ||
текст сообщения | "message" : "Fail to connect to Data Source." | ||
ScheduleDesc | параметры обновления | ||
"delayed": bool | false - создать мультисферу сразу true - создать мультисферу при первом обновлении | "delayed": false, | |
"items": [Item] | "items": [ | ||
Item | |||
"type": int | Тип:
| {"type": 2, | |
"time": int | если тип SCHEDULE_NONE / время в секундах от начала суток = hours * 3600 + minutes * 60 | "time": 43200, | |
"time_zone": Timezone | если тип SCHEDULE_NONE "UTC-1:00" : 0, | "time_zone": 18, | |
"week_day": int | если тип SCHEDULE_WEEKLY / Дни недели: 0 - Пн. ... 6 - Вск. | "week_day": 3 | |
"day": int | если тип SCHEDULE_MONTHLY / Дни месяца, например, "day": 9 | "day": 1}] | |
IntervalUpdateInfo | параметры интервального обновления (для типов данных: date, datetime) | "interval" : { | |
"type": IntervalUpdateType | тип интервального обновления: INTERVAL_TODAY - 0, | "type": 11, | |
"left_border": string, | значение размерности, с которого будут обновляться данные | "left_border": "02.09.2019, 00:00:00", | |
"right_border": string, | значение размерности, до которого будут обновляться данные | "right_border": "30.11.2019, 00:00:00", | |
"dimension_id": string | идентификатор размерности (типы: date, datetime) | "dimension_id": "8682926d"} | |
"for_the_last_period": string | параметр для ввода периода | "for_the_last_period": "week" | |
"number_of_periods": int | параметр для количества периодов | "number_of_periods: 1" | |
IncrementUpdateField | параметры инкрементального обновления (для типов данных: uint8, uint16, uint32, uint64, double, date, time, datetime) | ||
"field_id": string, | идентификатор поля данных (типы: uint8, uint16, uint32, uint64, double, date, time, datetime) | "field_id":"446568d3", | |
DeltaUpdateInfo | параметры обновления по изменённым записям | ||
"primary_key_dim": DimensionId | идентификатор размерности-первичного ключа | "primary_key_dim":"446368d3", | |
"timestamp_dim": DimensionId | идентификатор размерности-штампа времени | "timestamp_dim":"446268d3" | |
ModuleDesc | |||
"uuid": string, | идентификатор модуля | "uuid" : "c958ca5b-18e96906-a26c1620-0fb8a311", | |
"type_id": type_id_type, | тип модуля: OLAP - 500 | "type_id" : 600, | |
"parent": string, | идентификатор родительского модуля | "parent" : "7e734a11-97a4d99c-878cab37-460e3949", | |
"cube_id": string, | идентификатор мультисферы | "cube_id" : "61fce753", | |
"visible": bool, | видимость модуля. как правило в ответе только видимые модули | "visible" : true, | |
"status": ModuleStatus, | MODULE_INIT - 1 - статус по умолчанию MODULE_OK - 2 - модуль инициализирован MODULE_CLOSE - 3 - не имеет смысла MODULE_DEACTIVE - 4 - модуль неактивен (он присутствует в памяти, но не виден пользователю) MODULE_ERROR - 5 - статус не используется | "status" : 1, | |
"error": PlmError | статус выполнения | "error" : {"code" : 0} | |
"name": string | имя модуля | "name": "name" | |
UserPermissionDesc | список всех мультисфер с флагом доступности пользователю | ||
"cube_id": string, | идентификатор мультисферы | "cube_id": "773ed4f9", | |
"accessible": bool, | доступность мультисферы для пользователя | "accessible": true, | |
"cube_name": string | имя мультисферы | "cube_name": "ms_for_test1" | |
CubePermissionDesc | информация по правам пользователя на размерности и факты для указанной мультисферы | ||
"cube_id": string, | идентификатор мультисферы | "cube_id": "00000000", | |
"dimensions": [DimDesc] | список всех размерностей с флагом доступности пользователю | "dimensions": [ | |
DimDesc | параметры размерности | ||
идентификатор размерности | {"id": "74ce6d95", | ||
имя размерности | "name": "dim_name", | ||
тип данных OlapDataType: | "type": 2, | ||
поле игнорируется в правах, используется по назначению только в импорте FIELD_MARK_COMMON - 0 | "mark": 0, | ||
доступность размерности для пользователя | "accessible": false }] | ||
"facts": [FactDesc] | список всех фактов с флагом доступности пользователю | "facts": [ | |
FactDesc | параметры факта | ||
"id": FactId | идентификатор факта | {"id": "06bd6550", | |
"name": string | имя факта | "name": "fact_name", | |
"mark": int | поле используется по назначению только в импорте FIELD_MARK_COMMON - 0 | "mark": 0, | |
"accessible": bool | доступность факта для пользователя | "accessible": false | |
"nulls_allowed": bool | для факта допустимы пропуски значений | "nulls_allowed": false}] | |
CubeRestrictions | права по мультисферам на размерности и факты | ||
"cube_id": string, | идентификатор мультисферы | "cube_id":"2ab4c9f0", | |
"accessible": bool, | доступность мультисферы для пользователя | "accessible":false, | |
"available_dims": [string] | список идентификаторов доступных пользователю размерностей | "available_dims":["c72a9178","d9321c2a","d8a4cd41"], | |
"available_facts": [string] | список идентификаторов доступных пользователю фактов | "available_facts":["247a7e26","bb3c058b"] | |
"direct_access": bool | если true - куб доступен напрямую, false - доступен косвенно и сохранение не требуется | "direct_access": true | |
DimensionDescBase | параметры размерности | ||
"id": string, | идентификатор размерности | "id": "74ce6d95", | |
"name": string, | имя размерности | "name": "dim_name", | |
"type": OlapDataType, | тип данных OlapDataType: | "type": 2, | |
"mark": FieldMarkType | поле используется по назначению только в импорте FIELD_MARK_COMMON - 0 | "mark": 0 | |
DataSourceDesc : DimDesc | список размерностей с соответствующими полями исходных данных | ||
"id": string, | идентификатор размерности | "id": "8682926d", | |
"name": string, | имя размерности | "name": "Дата", | |
"type": OlapDataType, | тип данных OlapDataType: | "type": 8, | |
"mark": FieldMarkType, | поле используется по назначению только в импорте FIELD_MARK_COMMON - 0 | "mark": 0, | |
"field_id": string, | идентификатор поля данных, из которого была создана размерность | "field_id": "3f3f960b", | |
"db_field": string, | имя исходного поля данных | "db_field": "Дата", | |
"update_ts": Timestamp, | время последнего обновления | "update_ts": 1573556334857582, | |
"datasource": | имя источника данных | "datasource": "e3667a34", | |
"date_descendant": [OlapDataType] | используется, когда размерность типа дата | "date_descendant": [6, 7, 9, 10, 11, 13, 14, 12, 15, 16, 17] | |
new_dimension_name | используется для переименования исходной размерности типа date, когда date_descendant=6 | "new_dimension_name":"Исходная" | |
date_descendant_name | используется для переименования производной размерности типа date, когда date_descendant=6 | "date_descendant_name":"Производная" | |
DataSourceDesc : FactDesc | список фактов с соответствующими полями исходных данных | ||
"id": string, | идентификатор факта | "id": "87267b12", | |
"name": string, | имя факта | "name": "Кол_во", | |
"mark": FieldMarkType, | поле используется по назначению только в импорте FIELD_MARK_COMMON - 0 | "mark": 0, | |
"field_id": string, | идентификатор поля данных, из которого был создан факт | "field_id": "5efe7187", | |
"db_field": string, | имя исходного поля данных | "db_field": "Кол_во", | |
"update_ts": Timestamp, | время последнего обновления | "update_ts": 1573556334857607, | |
"datasource": string | имя источника данных | "datasource": "e3667a34" | |
"nulls_allowed": bool, | допустимость null в фактах | "nulls_allowed": true, | |
Link | параметры линков (линки - размерности, созданные из нескольких полей из разных источников данных) | ||
"id": string, | идентификатор связи | "id": "7e48aa51", | |
"name": string, | имя связи | "name": "client", | |
"field_ids": [string] | поля для связи | "field_ids": ["6e3dca0d", "efc53984"] |
Обязательные действия
- авторизоваться authenticate : login
Команды
- Получение списка доступных мультисфер (list_request/list_response)
- Получение информации о мультисфере (info_request/info_response)
- Изменение прав группы пользователей (change_users_group_permissions/users_group_response)
- Получение превью источника (data_preview_request/data_preview_response)
- Удаление мультисферы (del_cube/response)
- Получение полной информации о мультисфере (ext_info_several_sources_request/ext_info_several_sources_response)
- Получение списка мультисфер по паттерну (get_cubes_by_key/get_cubes_by_key_response)
- Разбор источников данных по полям и назначение идентификаторов для них (get_fields_request/get_fields_response)
- Запуск обновления мультисферы вручную (manual_update/response)
- Переименование мультисферы (rename/response)
- Сохранение полной информации о мультисфере (save_ext_info_several_sources_request/save_ext_info_several_sources_response)
- Остановить обновление мультисферы (stop_handle/response)
- Проверка и разбор источников данных, автоматическое определение размерностей и фактов, валидация связей и назначение им id (structure_preview_request/structure_preview_response)
- Проверка соединения с источником данных (test_source_connection_request/test_source_connection_response)
- Получение информации по правам пользователя на размерности и факты для указанной мультисферы (user_cube_permissions_request/user_cube_permissions_response)
- Получение информации о правах пользователя по всем мультисферам (user_permissions_request/user_permissions_response)
- Получение информации о правах группы пользователей на размерности и факты для указанной мультисферы (users_group_cube_permissions_request/users_group_cube_permissions_response)
- Получение информации о правах группы пользователей по всем мультисферам (users_group_permissions_request/users_group_permissions_response)
- Получить id для нового куба или проверить имя старого на дублирование (create_cube_request/create_cube_response)
- Запустить получение превью (run_preview/preview_running либо run_preview/preview_failed)
- Получить готовое превью (get_preview_result/preview либо get_preview_result/preview_failed)
- Получить статус превью (get_preview_status/preview_in_progress либо get_preview_status/preview_success либо get_preview_status/preview_failed)
- Получить полное описание куба (ext_info_several_sources_with_descendant_dims_request/ext_info_several_sources_with_descendant_dims_response)
Список кодировок для источников CSV
Общие ошибки
Код ошибки | Текст ошибки | Описание |
---|---|---|
"code": RequestAuthError (270) | "message": "Only authentication command allowed" | ошибка появляется, когда пользователь не залогинился |
"code": InvalidArgumentError (101) | "message": "Session Null pointer." | ошибка появляется, когда не получена сессия, пользователь или слой |
"code": RuntimeError (200) | "message": "Can't set permissions for user/group: no such user/group" | ошибка появляется, когда не удалось изменить права пользователю/группе пользователей, т.к. нет указанного пользователя или группы |
"code": RequestError (260) | "message": "User Cube command cast fail." | ошибка появляется, когда не удалось преобразовать команду к UserCubeCommand |
"code": RequestError (260) | "message": "User Cube command handle fail." | ошибка появляется, когда отправленная команда не описана на сервере |