Описание параметров
Имя | Описание | Пример | |
---|---|---|---|
Layer | параметры слоя | "layer": { | |
"uuid": string, | идентификатор слоя | "uuid": "ad82f172", | |
"name": string, | имя слоя | "name": "Layer name", | |
"is_public": bool, | расшарен слой или нет | "is_public": false, | |
"created_by": string, | имя пользователя, создавшего слой | "created_by": "user", | |
"create_timestamp": string, | время создания | "create_timestamp": 1572602413867827, | |
"module_descs": [ModuleDesc], | параметры модулей | "module_descs": [{ | |
"settings": {JsonObject}, | настройки слоя | "settings": {}, | |
"script_id": string, | идентификатор сценария, если на слой был загружен сценарий если на слой не был загружен сценария, то "script_id" : "00000000" | "script_id" : "c98d4800", | |
"runtime_id": string, | идентификатор, указанный в описании слоя, используется для сохранения сценария | "runtime_id" : "86687387", | |
"modules_error_info": [ModuleErrorDesc] | статус модуля | "modules_error_info": []} | |
ProfileDesc | |||
"uuid": string, | идентификатор сохраненного слоя | "uuid": "db65ba9b", | |
"name": string, | имя сохраненного слоя | "name": "name", | |
"is_public": bool, | расшарен сохраненный слой или нет | "is_public": false, | |
"created_by": string, | имя пользователя, создавшего сохраненный слой | "created_by": "user", | |
"create_timestamp": string, | время создания | "create_timestamp": 1572602413867827 | |
"update_time": string, | время изменения | "update_time" : 1617176528651286, | |
"runtime_id": string, | идентификатор, указанный в описании слоя, используется для сохранения сценария | "runtime_id" : "ae9c6893", | |
"script_id": string, | идентификатор сценария, если на слой был загружен сценарий если на слой не был загружен сценария, то "script_id" : "00000000" | "script_id" : "00000000", | |
"description": string, | описание профиля | "description" : "", | |
"used_cubes": [CubeDesc] | список используемых мультисфер в профиле | "used_cubes" : [ | |
ProfileDescription | описание профиля | ||
"layer_save_id": string, | id профиля под которым слой будет сохранен | "layer_save_id": "c98d4800" | |
"module_descs": [ModuleDesc] | параметры модулей | "module_descs": [{ | |
ScriptStatusError | список ошибок, возникших при воспроизведении сценария | "script_errors": [{ | |
"position": uint32_t, | номер шага, без учета сервисных шагов | "position":2 | |
"action_name": string, | имя шага | "action_name":"Перенос размерности "Дата квартал" влево", | |
"error": string | текст ошибки | "error":"Dimension invalid error ( :401 )"}] |
Обязательные действия
- авторизоваться authenticate : login
Команды
Общие ошибки
Код ошибки | Текст ошибки | Описание |
---|---|---|
"code": RequestAuthError (270) | "message": "Only authentication command allowed" | ошибка появляется, когда пользователь не залогинился |
"code": InvalidArgumentError (101) | "message": "Session Null pointer." | ошибка появляется, когда не получена сессия, пользователь или слой |
"code": RequestError (260) | "message": "User Dashboard command cast fail." | ошибка появляется, когда не удалось преобразовать команду к UserLayerCommand |
"code": RequestError (260) | "message": "State 'name' for UserLayerCommand is not handled" | ошибка появляется, когда отправленная команда не описана на сервере |