Описание параметров

Имя
Описание
Пример в 5.7
ScriptDescExtended параметры сценария


"id" :  string,идентификатор сценария"id": "0c883a77",


"name": string,имя сценария"name" : "script1",


"description": string, описание сценария"description" : "тестовый сценарий",


"steps_count": int,количество действий в сценарии"steps_count": 3,


"used_cubes":  [CubeState]список используемых мультисфер и их статус"used_cubes": [
{
"name": "test_polyogn",
"id": "3ff63962",
"state": "available"
},
{
"name": "test_polygon_locals",
"id": "b5946b35",
"state": "deleted"
},
{
"name": "test_cube1",
"id": "469f8d88",
"state": "unavailable"
}
],


"created_by": string,автор сценария"created_by" : "user",


"creation_ts": Timestamp,время создания сценария"creation_ts" : 1572948234656992,


"last_updated_ts": Timestamp,время изменения сценария"last_updated_ts" : 1591182304387047,


"last_played_ts": Timestamp,время последнего воспроизведения"last_played_ts": 0,


"is_shared": boolрасшарен сценарий или нет"is_shared" : false


"has_changes": boolизменнён ли сценарий(удалены/изменены шаги)"has_changes": true
CubeStateстатус мультисферы, используемой в сценарии


"name": string,имя мультисферы "name": "test_polyogn",


"id": string,идентификатор мультисферы"id": "3ff63962",


"state": string

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

  • available -доступна
  • deleted - удалена
  • unavailable - недоступна, недостаточно прав
"state": "available"
ScriptDescSimpleкраткое описание сценария

"uuid": stringid сценария"uuid": "b00d01b1-b00d01b1-b00d01b1-b00d01b1"

"name": string,имя сценария"name": "Сценарий 1",

"description": string, время создания "description": "описание",

"created_by": string,автор сценария"created_by" : "user",

"creation_ts": Timestamp,время создания сценария"creation_ts" : 1572948234656992,

"is_shared": boolрасшарен сценарий или нет"is_shared" : false

"last_update_ts": Timestamp,время изменения сценария"last_updated_ts" : 1591182304387047,

"are_all_cubes_available": boolдоступность кубов"are_all_cubes_available": true

"steps_count": intколичество шагов"steps_count": 12
ScriptDescBrief

параметры сценария




"id": string,

идентификатор сценария

при сохранении сценария:

  • пустой, если это новый сценарий
  • существующий, если требуется пересохранить сценарий
"id": "88cd3648",


"name": string,имя сценария"name": "новое имя",


"description": stringописание сценария"description": "новое описание сценария"
CommandDescпараметры действий сценария


"uuid": string,идентификатор действия"uuid": "6fc9ef71-ad77073e-213cddd4-0f0a7b5e",


"name": string,имя действия"name": "[UserIFaceCommand::save_settings(207-13)]",


"description": stringописание действия"description" : "",


"type": int,номер соответствующей команды в server-codes.json"type": 207,


"state": int,номер соответствующей команды в server-codes.json"state": 13,


"position": int,порядковый номер действия"position": 0,


"is_service_action": bool,является ли действие сервисным"is_service_action": true,


"is_editable": boolявляется ли действие редактируемым "is_editable": true


"is_deleted": boolявляется ли действие удаляемым"is_deleted": false
ScriptStatusпараметры выполнения сценария

"id": string,идентификатор сценария"id": "88cd3648",

"action_name": string,название шага"action_name" : "[UserLayerCommand::set_layer_settings(210-11)]",

"status": LayerScriptStatus, 

Unknown - 0 - не известно,
Loaded - 1 - сценарий загружен в слой,
Running - 2 - сценарий воспроизводится,
Finished - 3 - сценарий полностью воспроизведен,
Paused - 4 -  воспроизведение сценария приостановлено на каком-то шаге,
Interrupted - 5 - воспроизведение сценария прервано, дальнейшее воспроизведение невозможно,
Failure -  6 - критичная ошибка при воспроизведении сценария

"status": 1,

"current_step": int,

номер текущего шага

-1 - если сценарий был загружен на слой, но еще не воспроизведен, или если воспроизведение сценария было отменено

"current_step": 0

"error": stringсообщение с ошибкой, если статус 6 (Failure)"error" : "Error during playback of [[UserIFaceCommand::create_module(207-0)] RTId: 51a4eed6 CmdId: 7b9e4745-...]: Failed to get the resource with id 298fafaa: No such resource or the user does not own the resource ( Permission error:204 ) ( Runtime error:200 )"

"errors": список ошибок, возникших при воспроизведении сценария"errors" : [


"position": uint32_t,номер шага, без учета сервисных шагов{"position" : 0,


"action_name": string,имя шага"action_name" : "Запуск модуля \"multisphere\" - mpogosyan для сценариев",


"error": stringтекст ошибки"error" : "Failed to get the resource with id 9d1cfda6: No such resource or the user does not own the resource ( Permission error:204 )"}]
ModuleMetadataметаданные модуля

"cube_id": string,идентификатор мультисферы"cube_id":"b69bb1e9-00000000-00000000-00000000",

"cube_name": string,название мультисферы "cube_name":"Main_cube",

"module_id": string,идентификатор OLAP-модуля"module_id":"58d5c915-eeef60b9-134b1516-fed7a6f0",

"module_name": string,заголовок модуля"module_name":"Мультисфера - Main_cube",

"used_dimensions": [DimensionMetadata],список вынесенных размерностей"used_dimensions":[
{
"id":"9593b8d5",
"level":0,
"name":"Город",
"position":1,
"type":5
}],

"used_measures": [MeasuresMetadata]список видимых фактов"used_measures":[
{
"id":"6ee41337",
"measure_type":0,
"name":"Возраст",
"position":0,
"type":4
}]
DimensionMetadataметаданные размерности для сценария

"id": string,идентификатор размерности "id":"9593b8d5",

"name": string,имя размерности"level":0,

"level": uint,порядок размерности в рабочей области (слева направо)"name":"Город",

"position": uint,

позиция размерности в рабочей области

0. out - не вынесена
1. left - вынесена влево
2. top - вынесена вверх

"position":1,

"type": 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		"type":5
MeasuresMetadataметаданные факта для сценария

"id": string,идентификатор факта"id":"6ee41337",

"measure_type": OlapFactTypeвид факта

0. summ - значение
1. percent - процент
2. rank - ранг
3. count_distinct - количество уникальных
4. average - среднее
5. sigma - отклонение 
6. min - минимум
7. max - максимум
8. variation - изменение
9. percent_variation - изменение в процентах
10. cumulative - нарастающее
11. abc - ABC
12. median - медиана
13. count - количество

"measure_type":0,

"name": string,имя факта"name":"Количество",

"position": uintпозиция факта в рабочей области (слева направо)"position":0,

"type": 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		"type":4
PlmErrorстатус выполнения команды

"code": int,код выполнения/ошибки

"message": stringтекст выполнения/ошибки

Обязательные действия

Команды

Общие ошибки

Код ошибки
Текст ошибки
Описание
"code": RequestAuthError (270)"message": "Only authentication command allowed"ошибка появляется, когда пользователь не залогинился
"code": InvalidArgumentError (101)"message": "Session Null pointer."ошибка появляется, когда не получена сессия либо пользователь 
"code": RequestError (260)"message": "Failed to cast to ResourceCommand in handle_resource_command()"ошибка появляется, когда не удалось преобразовать команду к ScriptCommand
"code": RequestError (260)"State "" for ScriptCommand is not handled"ошибка появляется, когда указано некорректное значение параметра state
  • Нет меток