CubeDesc

параметры мультисферы

"uuid": string,

идентификатор мультисферы, CubeIdShort

"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,

мультисфера доступна только одному пользователю

• true — мультисфера доступна только одному пользователю (на любых правах);
• false — мультисферу доступна нескольким пользователям.

создание мультисферы при первом обновлении

количество источников

признак отмены обновления/удаления записей из мультисферы

• true — при выполнении операции отмены обновления/удаления записей из мультисферы;
• false — во всех остальных случаях.

признак возможности обновления мультисферы (источник не из файла)

общее количество открытий

время последнего начала обновления данных куба через механизм обновления

характер доступа к ресурсу
"personally" — доступ предоставлен лично или пользователь является создателем ресурса

"by_group" — доступ предоставлен через группу

"personally_and_by_group" — доступ предоставлен лично и через группу или пользователь является создателем ресурса и входит в группу, которой предоставлен доступ к ресурсу

"is_deleting": bool,

запущен процесс удаления строк из мультисферы или нет

"is_deleting" : false,

"delete_error": bool

возникли ли ошибки при удалении записей из мультисферы или нет (true, если возникли)

"delete_error": true

DataSourceDesc

параметры источника данных

"database": string,

имя базы данных

"database" : "",

"encoding": string,

"encoding" : "",

"fields": [FieldDesc],

строки импортируемых данных

идентификатор поля, FieldId

"id" : "bdc9dd55",

имя поля

"name" : "Дата",

тип данных

OlapDataType:
"uint8" : 0, "uint16" : 1, "uint32" : 2, "uint64" : 3, "double" : 4, "string" : 5, "date" : 6, "time" : 7, "datetime" : 8, "date_year" : 9, "date_quarter" : 10, "date_month" : 11, "date_day" : 12, "date_week" : 13, "date_wday" : 14, "time_hour" : 15, "time_minute" : 16, "time_second" : 17,
"none": 18,
"unknown": 19

"type" : 8,

FIELD_MARK_COMMON — 0

FIELD_MARK_CREATED — 1

FIELD_MARK_DELETED — 2

"mark" : 0

"id": string,

идентификатор источника данных, DataSourceId

"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,
"file" : 1,
"excel" : 2,
"csv" : 3,
"odbc" : 4,
"mssql" : 5,
"mysql" : 6,
"dsn" : 7,
"psql" : 8,
"h2" : 9,
"oracle" : 10,
"jdbc" : 11

"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

Тип:

• SCHEDULE_NONE - 0,
• SCHEDULE_DAILY - 1,
• SCHEDULE_WEEKLY - 2,
• SCHEDULE_MONTHLY - 3

{"type": 2,

если тип SCHEDULE_NONE / время в секундах от начала суток = hours * 3600 + minutes * 60

"time": 43200,

если тип SCHEDULE_NONE

"UTC-1:00" : 0,
"UTC-2:00" : 1,
"UTC-3:00" : 3,
"UTC-3:30" : 4,
"UTC-4:00" : 5,
"UTC-5:00" : 6,
"UTC-6:00" : 7,
"UTC-7:00" : 8,
"UTC-8:00" : 9,
"UTC-9:00" : 10,
"UTC-9:30" : 11,
"UTC-10:00" : 12,
"UTC-11:00" : 13,
"UTC-12:00" : 14,
"UTC±0:00" : 15,
"UTC+1:00" : 16,
"UTC+2:00" : 17,
"UTC+3:00" : 18,
"UTC+3:30" : 19,
"UTC+4:00" : 20,
"UTC+4:30" : 21,
"UTC+5:00" : 22,
"UTC+5:30" : 23,
"UTC+5:45" : 24,
"UTC+6:00" : 25,
"UTC+6:30" : 26,
"UTC+7:00" : 27,
"UTC+8:00" : 28,
"UTC+8:45" : 29,
"UTC+9:00" : 30,
"UTC+9:30" : 31,
"UTC+10:00" : 32,
"UTC+10:30" : 33,
"UTC+11:00" : 34,
"UTC+12:00" : 35,
"UTC+12:45" : 36,
"UTC+13:00" : 37,
"UTC+13:45" : 38,
"UTC+14:00" : 39

"time_zone": 18,

если тип SCHEDULE_WEEKLY / Дни недели: 0 - Пн. ... 6 - Вск.

"week_day": 3

если тип SCHEDULE_MONTHLY / Дни месяца, например, "day": 9

IntervalUpdateInfo

параметры интервального обновления (для типов данных: date, datetime)

"interval" : {

"type": IntervalUpdateType

тип интервального обновления:

INTERVAL_TODAY - 0,
INTERVAL_YESTERDAY - 1,
INTERVAL_THIS_WEEK - 2,
INTERVAL_LAST_WEEK - 3,
INTERVAL_THIS_MONTH - 4,
INTERVAL_LAST_MONTH - 5,
INTERVAL_THIS_QUARTER - 6,
INTERVAL_LAST_QUARTER - 7,
INTERVAL_THIS_YEAR - 8,
INTERVAL_LAST_YEAR - 9,
INTERVAL_DATE_FROM - 10,
INTERVAL_DATE_FROM_TO - 11,
INTERVAL_LAST_PERIOD 12

"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

параметр для количества периодов

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
GRAPH - 600
GEO - 700
ASSOCIATION_RULES - 800
CLUSTERIZATION - 900
FORECAST - 1000

"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:
"uint8" : 0, "uint16" : 1, "uint32" : 2, "uint64" : 3, "double" : 4, "string" : 5, "date" : 6, "time" : 7, "datetime" : 8, "date_year" : 9, "date_quarter" : 10, "date_month" : 11, "date_day" : 12, "date_week" : 13, "date_wday" : 14, "time_hour" : 15, "time_minute" : 16, "time_second" : 17,
"none": 18,
"unknown": 19

"type": 2,

 поле игнорируется в правах, используется по назначению только в импорте

FIELD_MARK_COMMON - 0
FIELD_MARK_CREATED - 1
FIELD_MARK_DELETED - 2

"mark": 0,

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

"accessible": false }]

"facts": [FactDesc]

список всех фактов с флагом доступности пользователю

"facts": [

FactDesc

параметры факта

идентификатор факта

{"id": "06bd6550",

имя факта

"name": "fact_name",

поле используется по назначению только в импорте

FIELD_MARK_COMMON - 0
FIELD_MARK_CREATED - 1
FIELD_MARK_DELETED - 2

"mark": 0,

доступность факта для пользователя

"accessible": false

для факта допустимы пропуски значений

"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:
"uint8" : 0, "uint16" : 1, "uint32" : 2, "uint64" : 3, "double" : 4, "string" : 5, "date" : 6, "time" : 7, "datetime" : 8, "date_year" : 9, "date_quarter" : 10, "date_month" : 11, "date_day" : 12, "date_week" : 13, "date_wday" : 14, "time_hour" : 15, "time_minute" : 16, "time_second" : 17,
"none": 18,
"unknown": 19

"type": 2,

"mark": FieldMarkType

поле используется по назначению только в импорте

FIELD_MARK_COMMON - 0
FIELD_MARK_CREATED - 1
FIELD_MARK_DELETED - 2

"mark": 0

FactDescBase

параметры факта

"id": string,

идентификатор факта

"name": string,

имя факта

"mark": int,

внутренняя информация

"nulls_allowed": bool

отметка о допустимости пустых ячеек в значениях факта

DataSourceDesc : DimDesc

список размерностей с соответствующими полями исходных данных

"id": string,

идентификатор размерности

"id": "8682926d",

"name": string,

имя размерности

"name": "Дата",

"type": OlapDataType,

тип данных

OlapDataType:
"uint8" : 0,
"uint16" : 1,
"uint32" : 2,
"uint64" : 3,
"double" : 4,
"string" : 5,
"date" : 6,
"time" : 7,
"datetime" : 8,
"date_year" : 9,
"date_quarter" : 10,
"date_month" : 11,
"date_day" : 12,
"date_week" : 13,
"date_wday" : 14,
"time_hour" : 15,
"time_minute" : 16,
"time_second" : 17,
"none": 18,
"unknown": 19

"type": 8,

"mark": FieldMarkType,

поле используется по назначению только в импорте

FIELD_MARK_COMMON - 0
FIELD_MARK_CREATED - 1
FIELD_MARK_DELETED - 2

"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": string

используется для переименования исходной размерности типа date, когда date_descendant=6

"new_dimension_name":"Исходная"

"date_descendant_name": string

используется для переименования производной размерности типа date, когда date_descendant=6

"date_descendant_name":"Производная"

DataSourceDesc : FactDesc

список фактов с соответствующими полями исходных данных

"id": string,

идентификатор факта

"id": "87267b12",

"name": string,

имя факта

"name": "Кол_во",

"mark": FieldMarkType,

поле используется по назначению только в импорте

FIELD_MARK_COMMON - 0
FIELD_MARK_CREATED - 1
FIELD_MARK_DELETED - 2

"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"]

RelevanceDate

дата актуальности данных мультисферы

"dimension_id": string

идентификатор выбранной размерности, максимальное значение которой будет выводиться как дата актуальности данных в окне мультисферы

"dimension_id": "00000000",

"data_type": OlapDataType

тип данных выбранной размерности
OlapDataType:
"date" : 6,
"datetime" : 8,
"unknown": 19

"data_type": 19,

"consider_filter": bool

учет фильтра в окне мультисферы: если true, то в окне мультисферы максимальное значение элемента выбранной размерности будет отображаться с учетом всех примененных фильтров, а если false, то без фильтров

"consider_filter": false

CleanUp

механизм очистки мультисферы

"querying_datasources": [QueryingDatasource]

механизм очистки мультисферы путем отправки SQL-запроса к источникам данных этой мультисферы

"querying_datasources": [
      {
        "datasource_id": "01234567",
        "query": "select * from foo",
        "field_id": "89abcdef"
      },
      {
        "datasource_id": "12345678",
        "query": "select * from bar",
        "field_id": "9abcdef0"
      }
    ]

"start_update_after": bool

запуск обновления мультисферы после удаления записей: true — обновление требуется, false — обновление не требуется

"start_update_after": true

QueryingDatasource

"datasource_id": string,

идентификатор источника данных мультисферы, которому нужно отправлять SQL-запрос; DataSourceId, или UUID_1 (см. описание параметра DataSourceDesc выше)

"datasource_id": "01234567",

"query": string,

SQL-запрос, возвращающий один столбец с удаляемыми элементами размерностей мультисферы

"query": "select * from foo",

"field_id": string

идентификатор поля, на основе которого создана размерность, элементы которой подлежат удалению; FieldId, или UUID_1 (см. описание FieldDesc выше)

"field_id": "89abcdef"