Описание параметров
Имя | Описание | Пример | |||
|---|---|---|---|---|---|
ModuleDesc | параметры модуля | ||||
| "uuid": string, | идентификатор модуля | "uuid": "b2d3ef65-9dda720e-2b2e86e5-a1691b1b", | |||
| "type_id": type_id_type, | тип модуля: OLAP - модуль мультисферы 500 GRAPH - модуль графики 600 GEO - модуль карт 700 ASSOCIATION_RULES - модуль ассоциативных правил 800 CLUSTERIZATION - модуль кластеризации 900 FORECAST - модуль прогнозирования 1000 | "type_id": 600, | |||
| "parent": string, | идентификатор родительского модуля | "parent": "65a4e2f6-9dacdfa8-4c9db23a-f8df6ec5", | |||
| "cube_id": string, | идентификатор мультисферы | "cube_id": "61fce753", | |||
| "visible": bool, | видимость модуля. как правило в ответе только видимые модули | "visible": true, | |||
| "status": ModuleStatus, | MODULE_INIT - 1 - статус по умолчанию | "status": 1, | |||
| "error": PlmError | статус выполнения | "error": {"code": 0} | |||
| "name": string | имя модуля | "name": "name" | |||
| InterfaceConfiguration | конфигурация интерфейса | "configuration" : { | |||
| "enabled_logout": bool, | видимость меню со сменой пароля и выходом из системы | "enabled_logout" : true, | |||
| "enabled_sharing": bool, | видимость иконок, связанных с разделением ресурсов | "enabled_sharing" : true, | |||
| "disable_remote_export_button": bool, | видимость иконки выгрузки данных из закрытого контура | "disable_remote_export_button" : false, | |||
| “datetime_format”: string | формат даты, указанный в конфигурационном файле. В этом формате необходимо отправлять данные, например, при фильтрации | "datetime_format":"%d/%m/%Y %H:%M:%S"} | |||
| "ml_enabled": bool | включение/выключение МЛ расчётов для колонки... | "ml_enabled": false | |||
| "ml_url": string | ... и URL | "ml_url": "" | |||
| "users_cant_share": bool | отключение кнопок шаринга профилей и сценариев для пользователей без роли администратора | "users_cant_share": false | |||
| "decimal_separator": string | Разделитель дробной и целой части чисел с плавающей точкой | "decimal_separator": "," | |||
| "user_can_not_reject_cubes": bool | Сокрытие функции "Отказаться" от получения прав на МС | "user_can_not_reject_cubes": true | |||
| "users_cant_save": bool | Сокрытие функции "Сохранить" для пользователей | "users_cant_save": true | |||
| "scenario_hyperlink_enabled": bool | Активация функционала перехода по связанным сценариям | "scenario_hyperlink_enabled": true | |||
| "link_outside": { | "link_outside": { | ||||
| "url": string, | URL | "url": "https://www.polymatica.ru/", | |||
| "open_in_current_tab": bool, | режим открытия URL: true - открывать url на текущей вкладке false - открывать url на новой вкладке | "open_in_current_tab": false, | |||
| "tip": string} | подсказка для URL | "tip": "Перейти в Полиматику"} | |||
Обязательные действия
Предварительно необходимо
- авторизоваться authenticate : login
- создать слой user_layer : create_layer
Команды
Общие ошибки
Код ошибки | Текст ошибки | Описание |
|---|---|---|
| "code": InvalidArgumentError (101) | "message": "Session Null pointer." | ошибка появляется, когда не получена сессия либо пользователь |
| "code": LayerError (308) | "message": "No such module." | ошибка появляется, когда указан несуществующий module_id |
| "code": RequestError (260) | "message": "User Interface command handle fail." | ошибка появляется, когда отправленная команда не описана на сервере |
| "code": LayerError (308) | "message": "Cant find layer with this module." | ошибка появляется, когда указан несуществующий layer_id |
| "code": RequestError (260) | "message": "User Interface command cast fail." | ошибка появляется, когда не удалось преобразовать команду к UserIFaceCommand |
| "code": RequestError (260) | "message": "User Interface command handle fail." | ошибка появляется, когда отправленная команда не описана на сервере |