Настоящая документация содержит справочную информацию по API Polymatica Analytics.

Модули, коды и команды API

Раздел предназначен для быстрой навигации по документации API Polymatica Analytics. В таблицах ниже собраны команды модулей с возможными состояниями. Более подробное описание команд доступно по ссылкам в соответствующих разделах таблиц.

Внимание

Названия команд остаются неизменными, а коды команд и состояний могут меняться. В таблице ниже приведены коды, актуальные на момент последнего обновления данной таблицы. Для получения наиболее актуальных кодов рекомендуется использовать файл "server-codes.json".

Глоссарий

ТерминОпределение
СистемаПолиматика любой версии
Модуль (Module)Компонент системы, ID модуля не меняется
Команда (Command)Команда, как правило является дочерней к модулю
Состояние (State)Состояние, это третий уровень иерархии API, часть команды


Для отправки запросов к системе можно использовать Swagger (веб приложение для отправки запросов) или Postman (платформа, устанавливаемая на локальную машину). 

Большая часть запросов имеет метод POST. В тех запросах, которые имеют другой метод и адрес, описание содержит тип метода и адрес http://polymatica.ru/api/v2 .
Отправляя запрос, необходимо открыть, например, swagger, указать в строку запроса http://polymatica.ru/api/v1. Этот адрес можно взять во вкладке Network → Headers (Request URL), открыв консоль разработчика на странице системы (F12).
В поле ввода запроса body запроса необходимо ввести данные запроса в формате, указанном в данном руководстве.
uuid - это идентификатор модуля, к которому производится запрос. Если запрос к модулю OLAP, то uuid содержит идентификатор OLAP. Если к модулю менеджер, то uuid содержит идентификатор менеджера.

{"state":0,"session":"","queries":[{"uuid":"e33358f9-ae5641c0-cbb8a078-b6f75b64","command":{"plm_type_code":502,"state":3,"position":0,"id":"e7c01ac2","level":0}}]}

Каждый модуль имеет свой уникальный код, указанный в таблицах ниже.

Модуль "Менеджер 200"

Модуль, ID модуляКоманда, ID командыСостояние, ID состояния
Менеджер, 200









action, 204list_rq, 1 / list_rp, 2
merge_enable, 7 / response, 8
authenticate, 205check, 1 / response, 3
login, 2 / response, 3
user, 206

get_info, 1 / info, 3
get_by_login, 2 / info, 3
list_request, 4 / list_response, 5
add_user, 6 / add_user_response, 7
del_user, 8 / response, 12
change_passwd, 9 / response, 12
change_user_passwd, 10 / response, 12
logout, 11 / response, 12

user_iface, 207

create_module, 0 / new_module_desc, 4 ИЗМЕНЕНИЯ
open_parent, 1 / new_module_desc, 4
clone_module, 2 / new_module_desc, 4
get_module, 5 / get_module_rp, 6
get_modules, 7 / modules, 9
close_module, 10 / response, 16
load_settings, 11 / load_settings_rp, 12
save_settings, 13 / response, 16
move_module, 15 / response, 16
get_configuration, 17 / get_configuration_rp, 18 
create_modules_from_profile, 19 / create_modules_from_profile_rp, 20 
rename_module, 21 / response, 16 

user_cube, 208list_request, 1 / list_response, 2
info_request, 3 / info_response, 4
manual_update, 9 / response, 25
stop_handle, 10 / response, 25
rename, 11 / response, 25
test_source_connection_request, 12 / test_source_connection_response, 13
data_preview_request, 14 / data_preview_response, 15
user_permissions_request, 16 / user_permission_response, 17
user_cube_permissions_request, 18 / user_cube_permissions_response, 19
change_user_permisions, 20 / response 23
del_cube, 22 / response, 23 
get_dimensions, 24 / get_dimensions_response, 25
ext_info_several_sources_request, 26 / ext_info_several_sources_response, 27
save_ext_info_several_sources_request, 28 / save_ext_info_several_sources_response, 29
structure_preview_request, 30 / structure_preview_response, 31
user_group_permissions_request, 32 / user_group_permissions_response, 33
users_group_cube_permissions_request, 34 / user_group_cube_permissions_response, 35
change_users_group_permissions, 36 / users group response, 37
get_cubes_by_key, 38 / get_cubes_by_key_response, 39
get_fields_request, 40 / get_fields_response, 41
create_cube_request, 42 / create_cube_response, 43
user_layer, 210

create_layer, 1 / layer_rp, 6
get_layer, 2 / layer_rp, 6
load_saved_layer, 3 / layer_rp, 6
init_layer, 4 / layer_rp, 6 ИЗМЕНЕНИЯ
clone_layer, 5 / layer_rp, 6
save_layer, 7 / save_layer_rp, 8
remove_saved_layer, 9 / layer_command_rp, 18
close_layer, 10 / layer_command_rp, 18
set_layer_settings, 11 / layer_command_rp, 17 ИЗМЕНЕНИЯ
set_layer_modules_order, 12 / public_saved_layer, 13 НЕ ПОДДЕРЖИВАЕТСЯ В 5.7
rename_layer, 14 / layer_command_rp, 17 ИЗМЕНЕНИЯ
rename_saved_layer, 15 / layer_command_rp, 17 ИЗМЕНЕНИЯ
set_active_layer, 16 / layer_command_rp, 17 ИЗМЕНЕНИЯ
remove_binding, 17 / layer_command_rp, 17 НЕ ПОДДЕРЖИВАЕТСЯ В 5.7
get_saved_layers, 19 / get_saved_layers_rp, 20 ИЗМЕНЕНИЯ
get_session_layers, 21 / get_session_layers_rp, 22 ИЗМЕНЕНИЯ
get_saved_screenshot, 23 / get_saved_screenshot_rp, 24 ИЗМЕНЕНИЯ
get_load_progress, 25 / get_load_progress_rp, 26 ИЗМЕНЕНИЯ
set_binding, 27 / binding_rp, 28 НЕ ПОДДЕРЖИВАЕТСЯ В 5.7

dim_element_permission, 211

get_data, 1 / rp_data, 4
pattern_change, 2 / rp_data, 4
range_change, 3 / rp_data, 4
filter_all_flag, 5 / flags_rp, 8 НЕ ПОДДЕРЖИВАЕТСЯ В 5.7
unfilter_all_flag, 6 / flags_rp, 8
invert_all_flag, 7 / flags_rp, 8
apply_data, 9 / rp, 10 
filter_by_name, 11 / filter_by_name_rp, 12 НЕ ПОДДЕРЖИВАЕТСЯ В 5.7
set, 17 / response, 20 НЕ ПОДДЕРЖИВАЕТСЯ В 5.7
cancel, 18 / response, 20
clear, 19 / response, 20

dim_element_multifilter, 213get_data, 1 / rp_data, 4
pattern_change, 2 / rp_data, 4
range_change, 3 / rp_data, 4
filter_all_flag, 5 / flags_rp, 8
unfilter_all_flag,6 / flags_rp, 8
invert_all_flag, 7 / flags_rp, 8
apply_data, 9 / rp, 10
set, 17 / response, 21
cancel, 18 / response, 21
clear, 19 / clear_all, 20
get_filter_status, 22 / get_filter_status_rp, 23

editions, 215 НЕ ПОДДЕРЖИВАЕТСЯ В 5.7

create, 1 / create_rp, 2
delete, 3 / response, 7
load, 4 / response, 7
edit, 5 / response, 7
publish, 6 / response, 7
list, 8 / list_rp, 9

script, 217 НЕ ПОДДЕРЖИВАЕТСЯ В 5.7 (для версии 5.7 см. scripts, 227 ниже)

Write_start, 0 / write_start_rp, 1
Write_stop, 2 / write_stop_rp, 3
Run, 4 / run_rp, 5
List, 6 / list_rp, 7
list_action, 8 / list_action_rp, 9
Edit, 10 / edit_rp, 11
Delete, 12 / delete_rp, 13
Run_progress, 14 / run_progress_rp, 15
Run_stop, 16 / run_stop_rp, 17
list_actions_write, 18 / list_actions_write_rp, 19
public, 20 / public_rp, 21

group, 218get_info, 1 / get_info_response, 2
list_request, 3 / list_response, 4
add_group, 5 / add_group_response, 6
edit_group, 7 / response, 12
del_group, 8 / response, 12
add_member, 9 / response, 12
del_member, 10 / response, 12
move_member, 11 / response, 12
list_member_groups, 13 / list_member_groups_response, 14
edit_member_groups, 15 / edit_member_groups_response, 16
permissions, 219

get_member_cubes_list 1 / get_member_cubes_list_rp 2
get_detailed_cube_permissions 3 / get_detailed_cube_permissions_rp 4
set_detailed_cube_permissions 5 / set_detailed_cube_permissions_rp 6

resource, 224

revoke, 0 / response, 3
delete, 1 / response, 3
reject, 2 / response, 3
share_with_multiple_recipients, 4 / share_with_multiple_recipients_rp, 5
share_multiple_resources, 6 / share_multiple_resources_rp, 7
get_owners_by_resource, 8 / get_owners_by_resource_rp, 9
get_resources_by_owner, 10 / get_resources_by_owner_rp, 11
resource_rescan_repo, 12/ resource_rescan_repo_rp, 13
resource_make_copy, 14/ resource_make_copy_rp, 15

scripts, 227 НОВЫЙ

load_on_layer, 1 / generic_rp, 24
play_to_position, 2 / generic_rp, 24
pause, 3 / generic_rp, 24
interrupt, 4 / generic_rp, 24
get_script_status, 5 / get_script_status_rp, 6
get_script_description, 7 / get_script_description_rp, 8
get_script_descriptions_list, 9 / get_script_descriptions_list_rp, 10
get_action_description, 11 / get_action_description_rp, 12
get_action_by_position, 13 / get_action_by_position_rp, 14
get_action_dependencies, 15 / get_action_dependencies_rp, 16
replace_action_on_position, 17 / generic_rp, 24
delete_actions_on_positions, 18 / generic_rp, 24
delete_actions_from_position, 19 / generic_rp, 24
save_from_layer_history, 20 / save_rp, 22
save_from_layer_script_history, 21 / save_rp, 22
rename_saved_script, 23 / generic_rp, 24
get_script_metadata, 25 / get_script_metadata_rp, 26

Модуль "Мультисфера 500" 

Модуль, ID модуляКоманда, ID командыСостояние, ID состояния

OLAP, 500

dimension, 502

list_rq, 1 / list_rp, 2
move, 3 / rp, 9
move_all, 4 / rp, 9
dimension, 5 / rp, 9
delete, 6 / rp, 9
clear_workspace, 8 / rp, 9
create_copy, 10 / create_response, 12
create_union, 11 / create_response, 12
distribute_elements_to clusters, 13 / rp, 9
copy_and_group_by_expression_rq, 14 / copy_and_group_by_expression_rp, 15
get_parameters, 16 / get_parameters_rp, 17 
try_to_delete, 18 / try_to_delete_rp, 19 

fact, 503list_rq, 1 / list_rp, 2
create_copy, 3 / create_rp, 7
create_calc, 4 / create_rp, 7
create_user_from_calc, 5 / create_rp, 7
create_group, 6 / create_rp, 7
edit_calc, 8 / response, 25
set_type, 9 / response, 25
set_level, 10 / response, 25
set_direction, 11 / response, 25
set_visible, 12 / response, 25
set_selection, 13 / response, 25
set_visible_multi, 14 / response, 25
set_selection_multi, 15 / response, 25
del, 16 / response, 25
select_all, 17 / response, 25
unselect_all, 18 / response, 25
hide_selected, 19 / response, 25
unhide_selected, 20 / response, 25
hide_unselected, 21 / response, 25
ungroup_selected, 22 / response, 25
move, 23 / response, 25
rename, 24 / response, 25
filter, 504get_data, 1 / rp_data, 4
pattern_change, 2 / rp_data, 4
range_change, 3 / rp_data, 4
filter_all_flag, 5 / flags_rp, 8
unfilter_all_flag, 6 / flags_rp, 8
invert_all_flag, 7 / flags_rp, 8
apply_data, 9 / rp_data, 4
filter_by_name, 11 / filter_by_name_rp, 12
add_element, 13 / user_element_rp, 16
rename_element, 14 / user_element_rp, 16
remove_element, 15 / user_element_rp, 16
set, 17 / response, 22
cancel, 18 / response, 22
clear, 19 / response, 22
transfer, 20 / response, 22
fetch, 21 / response, 22
apply, 23 / response, 22
fetch_get, 26 / fetch_get_rp, 27
filter_get, 28 / filter_get_rp, 29
filter_get_status, 30 / filter_get_status_r, 31
group, 505get, 1 / data, 2
remove, 3 / response, 5
set_name, 4 / response, 5
get_description, 6 / description, 7
view, 506

get, 1 / data, 2
get_hints, 3 / hints, 5
get_context, 5 / context, 7
fps, 6 / context, 7
f_sel, 8 / response, 28
f_unsel, 9 / response, 28
fold, 10 / response, 28
fold_all, 11 / response, 28
unfold_all, 12 / response, 28
fold_all_at_level, 13 / response, 28
unfold_all_at_level, 14 / response, 28
select, 15 / response, 28 ИЗМЕНЕНИЯ
sel_multi, 16 / response, 28 ИЗМЕНЕНИЯ
sell_all, 17 / response, 28 ИЗМЕНЕНИЯ
unsel_all, 18 / response, 28 ИЗМЕНЕНИЯ
group, 19 / response, 28
set_sort, 20 / response, 28
change_show_inter_total_mode, 21 / response, 28
add_dimension_element, 22 / response, 28
rename_dimension_element, 23 / response, 28
del_dimension_element, 24 / response, 28 ИЗМЕНЕНИЯ
fill_sublevel_of_element, 25 / response, 28
change_fact_value, 26 / response, 28
distribute_fact_total, 27 / response, 28
get_2, 29 / data_2, 30
set_sort_dimension, 31 / response, 28 
set_show_horizontal_total_mode, 36 / set_show_horizontal_total_mode_rp, 37 
set_show_vertical_total_mode, 38 / set_show_vertical_total_mode_rp, 39 
set_show_inter_total_mode, 40/ set_show_inter_total_mode, 41 

xls_export, 130start, 1 / response, 4
check, 2 / response, 4
abort, 3 / response, 4

Модуль "Графика 600" 

Модуль, ID модуляКоманда, ID командыСостояние, ID состояния
graph, 600









graph, 601

get_available_types, 1 / get_available_types_rp, 2
get_info, 3 / get_info_rp, 4
stop, 5 / stopped, 6
run, 7 / run_rp, 8
check, 9 / error, 10 / state_changed, 11 / idle, 12 / done, 13
get, 14 / data, 15
zoom, 16 / zoom_rp, 17
set_selection, 18 / set_selection_rp, 19
drill, 20 / drill_rp, 21
get_top_dimension_info, 22 / get_top_dimension_info_rp, 23
pie_create_sector_other, 24 / pie_create_sector_other_rp, 25
pie_get_sector_other_element_names, 26 / pie_get_sector_other_element_names_rp, 27

Модуль "Карты 700" 

Модуль, ID модуляКоманда, ID командыСостояние, ID состояния
maps, 700









geo, 701start, 1 / start_rp, 2
stop, 2 / unspecified_response, 22
check, 4 / check_rp, 5
get, 6 / get_rp, 7
set_address_format, 8 / get_address_format_rp, 10
get_address_format, 9 / get_address_format_rp, 10
set_binded_address_format, 11 / get_binded_address_format_rp, 13
get_binded_address_format, 12 / get_binded_address_format_rp, 13
get_binded_address_info, 14 / get_binded_address_info_rp, 15
set_point_position, 16 / unspecified_response, 22
set_selection, 17 / unspecified_response, 22
get_tiles_data, 18 / get_tiles_data_rp, 19
get_top_dimension_info, 19 / get_top_dimension_info_rp, 20

Модуль "Ассоциативные правила 800" 

Модуль, ID модуляКоманда, ID командыСостояние, ID состояния
association, 800









association, 801prerun, 1 / response, 6
check, 2 / response, 6
stop, 3 / response, 6
run, 4 / response, 6
select, 5 / response, 6
get, 7 / data, 12
set_length, 8 / data, 12
set_pattern, 9 / data, 12
set_sort, 10 / data, 12
set_limits, 11 / data, 12
get_rules, 13 / rules, 14
start_graph, 15 / response, 6
get_graph, 16 / graph_data, 17
start_dendrogram, 18 / response, 6
get_dendrogram, 19 / dendrogram_data, 20
fold_rules, 21 / fold_rules_rp, 24
fold_all_rules, 22 / fold_rules_rp, 24
unfold_all_rules, 23 / fold_rules_rp, 24

Модуль "Кластеризация 900" 

Модуль, ID модуляКоманда, ID командыСостояние, ID состояния
cluster, 900





cluster, 901run, 1 / response, 5
check, 2 / response, 5
stop, 3 / response, 5
change_solution, 4 / response, 5
apply, 6 / apply_rp, 7

Модуль "Прогнозирование 1000" 

Модуль, ID модуляКоманда, ID командыСостояние, ID состояния
forecast, 1000forecast, 1001get, 1 / idle, 4 / response, 2
run, 3 / run, 3
stop, 5 / stop, 5
  • Нет меток