tb-rest-client 3.9.0__py3-none-any.whl
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- tb_rest_client/__init__.py +16 -0
- tb_rest_client/api/__init__.py +14 -0
- tb_rest_client/api/api_ce/__init__.py +66 -0
- tb_rest_client/api/api_ce/admin_controller_api.py +2250 -0
- tb_rest_client/api/api_ce/alarm_comment_controller_api.py +376 -0
- tb_rest_client/api/api_ce/alarm_controller_api.py +1639 -0
- tb_rest_client/api/api_ce/asset_controller_api.py +2040 -0
- tb_rest_client/api/api_ce/asset_profile_controller_api.py +934 -0
- tb_rest_client/api/api_ce/audit_log_controller_api.py +587 -0
- tb_rest_client/api/api_ce/auth_controller_api.py +882 -0
- tb_rest_client/api/api_ce/component_descriptor_controller_api.py +340 -0
- tb_rest_client/api/api_ce/customer_controller_api.py +731 -0
- tb_rest_client/api/api_ce/dashboard_controller_api.py +2364 -0
- tb_rest_client/api/api_ce/device_api_controller_api.py +1212 -0
- tb_rest_client/api/api_ce/device_connectivity_controller_api.py +332 -0
- tb_rest_client/api/api_ce/device_controller_api.py +2737 -0
- tb_rest_client/api/api_ce/device_profile_controller_api.py +1120 -0
- tb_rest_client/api/api_ce/domain_controller_api.py +563 -0
- tb_rest_client/api/api_ce/edge_controller_api.py +2475 -0
- tb_rest_client/api/api_ce/edge_event_controller_api.py +178 -0
- tb_rest_client/api/api_ce/entities_version_control_controller_api.py +1327 -0
- tb_rest_client/api/api_ce/entity_query_controller_api.py +542 -0
- tb_rest_client/api/api_ce/entity_relation_controller_api.py +1355 -0
- tb_rest_client/api/api_ce/entity_view_controller_api.py +1828 -0
- tb_rest_client/api/api_ce/event_controller_api.py +623 -0
- tb_rest_client/api/api_ce/image_controller_api.py +1295 -0
- tb_rest_client/api/api_ce/login_endpoint_api.py +142 -0
- tb_rest_client/api/api_ce/lwm_2m_controller_api.py +142 -0
- tb_rest_client/api/api_ce/mail_config_template_controller_api.py +134 -0
- tb_rest_client/api/api_ce/mobile_app_bundle_controller_api.py +562 -0
- tb_rest_client/api/api_ce/mobile_app_controller_api.py +563 -0
- tb_rest_client/api/api_ce/mobile_application_controller_api.py +508 -0
- tb_rest_client/api/api_ce/notification_controller_api.py +1480 -0
- tb_rest_client/api/api_ce/notification_rule_controller_api.py +447 -0
- tb_rest_client/api/api_ce/notification_target_controller_api.py +776 -0
- tb_rest_client/api/api_ce/notification_template_controller_api.py +550 -0
- tb_rest_client/api/api_ce/o_auth_2_config_template_controller_api.py +324 -0
- tb_rest_client/api/api_ce/o_auth_2_controller_api.py +915 -0
- tb_rest_client/api/api_ce/ota_package_controller_api.py +879 -0
- tb_rest_client/api/api_ce/qr_code_settings_controller_api.py +508 -0
- tb_rest_client/api/api_ce/queue_controller_api.py +558 -0
- tb_rest_client/api/api_ce/queue_stats_controller_api.py +352 -0
- tb_rest_client/api/api_ce/rpc_v_1_controller_api.py +253 -0
- tb_rest_client/api/api_ce/rpc_v_2_controller_api.py +570 -0
- tb_rest_client/api/api_ce/rule_chain_controller_api.py +2201 -0
- tb_rest_client/api/api_ce/rule_engine_controller_api.py +515 -0
- tb_rest_client/api/api_ce/tb_resource_controller_api.py +1379 -0
- tb_rest_client/api/api_ce/telemetry_controller_api.py +1808 -0
- tb_rest_client/api/api_ce/tenant_controller_api.py +657 -0
- tb_rest_client/api/api_ce/tenant_profile_controller_api.py +932 -0
- tb_rest_client/api/api_ce/two_factor_auth_config_controller_api.py +890 -0
- tb_rest_client/api/api_ce/two_factor_auth_controller_api.py +332 -0
- tb_rest_client/api/api_ce/ui_settings_controller_api.py +134 -0
- tb_rest_client/api/api_ce/usage_info_controller_api.py +132 -0
- tb_rest_client/api/api_ce/user_controller_api.py +2645 -0
- tb_rest_client/api/api_ce/widget_type_controller_api.py +1505 -0
- tb_rest_client/api/api_ce/widgets_bundle_controller_api.py +752 -0
- tb_rest_client/api/api_pe/__init__.py +67 -0
- tb_rest_client/api/api_pe/admin_controller_api.py +2310 -0
- tb_rest_client/api/api_pe/alarm_comment_controller_api.py +372 -0
- tb_rest_client/api/api_pe/alarm_controller_api.py +1629 -0
- tb_rest_client/api/api_pe/asset_controller_api.py +1648 -0
- tb_rest_client/api/api_pe/asset_profile_controller_api.py +1029 -0
- tb_rest_client/api/api_pe/audit_log_controller_api.py +587 -0
- tb_rest_client/api/api_pe/auth_controller_api.py +882 -0
- tb_rest_client/api/api_pe/billing_endpoint_controller_api.py +868 -0
- tb_rest_client/api/api_pe/blob_entity_controller_api.py +554 -0
- tb_rest_client/api/api_pe/chirp_stack_integration_controller_api.py +838 -0
- tb_rest_client/api/api_pe/cloud_endpoint_controller_api.py +298 -0
- tb_rest_client/api/api_pe/component_descriptor_controller_api.py +340 -0
- tb_rest_client/api/api_pe/converter_controller_api.py +851 -0
- tb_rest_client/api/api_pe/converter_library_controller_api.py +915 -0
- tb_rest_client/api/api_pe/custom_menu_controller_api.py +1090 -0
- tb_rest_client/api/api_pe/custom_translation_controller_api.py +757 -0
- tb_rest_client/api/api_pe/customer_controller_api.py +1413 -0
- tb_rest_client/api/api_pe/dashboard_controller_api.py +2194 -0
- tb_rest_client/api/api_pe/device_api_controller_api.py +1212 -0
- tb_rest_client/api/api_pe/device_connectivity_controller_api.py +332 -0
- tb_rest_client/api/api_pe/device_controller_api.py +2468 -0
- tb_rest_client/api/api_pe/device_group_ota_package_controller_api.py +334 -0
- tb_rest_client/api/api_pe/device_profile_controller_api.py +1215 -0
- tb_rest_client/api/api_pe/domain_controller_api.py +549 -0
- tb_rest_client/api/api_pe/edge_controller_api.py +2638 -0
- tb_rest_client/api/api_pe/edge_event_controller_api.py +178 -0
- tb_rest_client/api/api_pe/entities_version_control_controller_api.py +1335 -0
- tb_rest_client/api/api_pe/entity_group_controller_api.py +3936 -0
- tb_rest_client/api/api_pe/entity_query_controller_api.py +542 -0
- tb_rest_client/api/api_pe/entity_relation_controller_api.py +1355 -0
- tb_rest_client/api/api_pe/entity_view_controller_api.py +1549 -0
- tb_rest_client/api/api_pe/event_controller_api.py +623 -0
- tb_rest_client/api/api_pe/group_permission_controller_api.py +720 -0
- tb_rest_client/api/api_pe/http_integration_controller_api.py +358 -0
- tb_rest_client/api/api_pe/image_controller_api.py +1505 -0
- tb_rest_client/api/api_pe/integration_controller_api.py +1592 -0
- tb_rest_client/api/api_pe/login_endpoint_api.py +142 -0
- tb_rest_client/api/api_pe/lwm_2m_controller_api.py +142 -0
- tb_rest_client/api/api_pe/mail_config_template_controller_api.py +134 -0
- tb_rest_client/api/api_pe/mobile_app_bundle_controller_api.py +562 -0
- tb_rest_client/api/api_pe/mobile_app_controller_api.py +549 -0
- tb_rest_client/api/api_pe/mobile_application_controller_api.py +581 -0
- tb_rest_client/api/api_pe/notification_controller_api.py +1476 -0
- tb_rest_client/api/api_pe/notification_rule_controller_api.py +447 -0
- tb_rest_client/api/api_pe/notification_target_controller_api.py +776 -0
- tb_rest_client/api/api_pe/notification_template_controller_api.py +550 -0
- tb_rest_client/api/api_pe/o_auth_2_config_template_controller_api.py +324 -0
- tb_rest_client/api/api_pe/o_auth_2_controller_api.py +816 -0
- tb_rest_client/api/api_pe/ota_package_controller_api.py +1010 -0
- tb_rest_client/api/api_pe/owner_controller_api.py +285 -0
- tb_rest_client/api/api_pe/qr_code_settings_controller_api.py +595 -0
- tb_rest_client/api/api_pe/queue_controller_api.py +558 -0
- tb_rest_client/api/api_pe/queue_stats_controller_api.py +339 -0
- tb_rest_client/api/api_pe/report_controller_api.py +245 -0
- tb_rest_client/api/api_pe/role_controller_api.py +546 -0
- tb_rest_client/api/api_pe/rpc_controller_api.py +257 -0
- tb_rest_client/api/api_pe/rpc_v_1_controller_api.py +253 -0
- tb_rest_client/api/api_pe/rpc_v_2_controller_api.py +570 -0
- tb_rest_client/api/api_pe/rule_chain_controller_api.py +2201 -0
- tb_rest_client/api/api_pe/rule_engine_controller_api.py +499 -0
- tb_rest_client/api/api_pe/scheduler_event_controller_api.py +1140 -0
- tb_rest_client/api/api_pe/self_registration_controller_api.py +587 -0
- tb_rest_client/api/api_pe/sig_fox_integration_controller_api.py +838 -0
- tb_rest_client/api/api_pe/sign_up_controller_api.py +882 -0
- tb_rest_client/api/api_pe/solution_controller_api.py +514 -0
- tb_rest_client/api/api_pe/subscription_controller_api.py +310 -0
- tb_rest_client/api/api_pe/t_mobile_iot_cdp_integration_controller_api.py +838 -0
- tb_rest_client/api/api_pe/tb_resource_controller_api.py +1379 -0
- tb_rest_client/api/api_pe/telemetry_controller_api.py +1808 -0
- tb_rest_client/api/api_pe/tenant_controller_api.py +750 -0
- tb_rest_client/api/api_pe/tenant_profile_controller_api.py +932 -0
- tb_rest_client/api/api_pe/thing_park_integration_controller_api.py +1741 -0
- tb_rest_client/api/api_pe/translation_controller_api.py +690 -0
- tb_rest_client/api/api_pe/two_factor_auth_config_controller_api.py +890 -0
- tb_rest_client/api/api_pe/two_factor_auth_controller_api.py +332 -0
- tb_rest_client/api/api_pe/ui_settings_controller_api.py +134 -0
- tb_rest_client/api/api_pe/usage_info_controller_api.py +132 -0
- tb_rest_client/api/api_pe/user_controller_api.py +3328 -0
- tb_rest_client/api/api_pe/user_permissions_controller_api.py +134 -0
- tb_rest_client/api/api_pe/white_labeling_controller_api.py +1056 -0
- tb_rest_client/api/api_pe/widget_type_controller_api.py +1410 -0
- tb_rest_client/api/api_pe/widgets_bundle_controller_api.py +847 -0
- tb_rest_client/api_client.py +705 -0
- tb_rest_client/configuration.py +234 -0
- tb_rest_client/models/__init__.py +14 -0
- tb_rest_client/models/models_ce/__init__.py +493 -0
- tb_rest_client/models/models_ce/account_configverification_code_body.py +98 -0
- tb_rest_client/models/models_ce/account_two_fa_settings.py +124 -0
- tb_rest_client/models/models_ce/activate_user_request.py +154 -0
- tb_rest_client/models/models_ce/admin_settings.py +232 -0
- tb_rest_client/models/models_ce/admin_settings_id.py +127 -0
- tb_rest_client/models/models_ce/affected_tenant_administrators_filter.py +104 -0
- tb_rest_client/models/models_ce/affected_user_filter.py +104 -0
- tb_rest_client/models/models_ce/alarm.py +707 -0
- tb_rest_client/models/models_ce/alarm_assignee.py +202 -0
- tb_rest_client/models/models_ce/alarm_assignment_notification_rule_trigger_config.py +216 -0
- tb_rest_client/models/models_ce/alarm_comment.py +292 -0
- tb_rest_client/models/models_ce/alarm_comment_id.py +127 -0
- tb_rest_client/models/models_ce/alarm_comment_info.py +376 -0
- tb_rest_client/models/models_ce/alarm_comment_notification_rule_trigger_config.py +248 -0
- tb_rest_client/models/models_ce/alarm_condition.py +154 -0
- tb_rest_client/models/models_ce/alarm_condition_filter.py +214 -0
- tb_rest_client/models/models_ce/alarm_condition_filter_key.py +160 -0
- tb_rest_client/models/models_ce/alarm_condition_spec.py +135 -0
- tb_rest_client/models/models_ce/alarm_count_query.py +372 -0
- tb_rest_client/models/models_ce/alarm_data.py +855 -0
- tb_rest_client/models/models_ce/alarm_data_page_link.py +450 -0
- tb_rest_client/models/models_ce/alarm_data_query.py +254 -0
- tb_rest_client/models/models_ce/alarm_id.py +162 -0
- tb_rest_client/models/models_ce/alarm_info.py +803 -0
- tb_rest_client/models/models_ce/alarm_notification_rule_trigger_config.py +223 -0
- tb_rest_client/models/models_ce/alarm_rule.py +206 -0
- tb_rest_client/models/models_ce/alarm_schedule.py +166 -0
- tb_rest_client/models/models_ce/all_users_filter.py +104 -0
- tb_rest_client/models/models_ce/allow_create_new_devices_device_profile_provision_configuration.py +104 -0
- tb_rest_client/models/models_ce/android_config.py +202 -0
- tb_rest_client/models/models_ce/any_time_schedule.py +104 -0
- tb_rest_client/models/models_ce/api_image_body.py +177 -0
- tb_rest_client/models/models_ce/api_usage_limit_notification_rule_trigger_config.py +170 -0
- tb_rest_client/models/models_ce/api_usage_state_filter.py +130 -0
- tb_rest_client/models/models_ce/asset.py +367 -0
- tb_rest_client/models/models_ce/asset_id.py +162 -0
- tb_rest_client/models/models_ce/asset_info.py +451 -0
- tb_rest_client/models/models_ce/asset_profile.py +422 -0
- tb_rest_client/models/models_ce/asset_profile_id.py +162 -0
- tb_rest_client/models/models_ce/asset_profile_info.py +232 -0
- tb_rest_client/models/models_ce/asset_search_query.py +180 -0
- tb_rest_client/models/models_ce/asset_search_query_filter.py +266 -0
- tb_rest_client/models/models_ce/asset_type_filter.py +182 -0
- tb_rest_client/models/models_ce/atomic_integer.py +228 -0
- tb_rest_client/models/models_ce/attribute_export_data.py +280 -0
- tb_rest_client/models/models_ce/attributes_entity_view.py +185 -0
- tb_rest_client/models/models_ce/audit_log.py +434 -0
- tb_rest_client/models/models_ce/audit_log_id.py +127 -0
- tb_rest_client/models/models_ce/auto_commit_settings.py +103 -0
- tb_rest_client/models/models_ce/auto_version_create_config.py +202 -0
- tb_rest_client/models/models_ce/aws_sns_sms_provider_configuration.py +188 -0
- tb_rest_client/models/models_ce/backup_code_two_fa_account_config.py +157 -0
- tb_rest_client/models/models_ce/backup_code_two_fa_provider_config.py +130 -0
- tb_rest_client/models/models_ce/boolean_filter_predicate.py +162 -0
- tb_rest_client/models/models_ce/branch_info.py +150 -0
- tb_rest_client/models/models_ce/bulk_import_request.py +150 -0
- tb_rest_client/models/models_ce/bulk_import_result_asset.py +202 -0
- tb_rest_client/models/models_ce/bulk_import_result_asset_created.py +254 -0
- tb_rest_client/models/models_ce/bulk_import_result_device.py +202 -0
- tb_rest_client/models/models_ce/bulk_import_result_edge.py +202 -0
- tb_rest_client/models/models_ce/button.py +286 -0
- tb_rest_client/models/models_ce/byte_array_resource.py +332 -0
- tb_rest_client/models/models_ce/byte_buffer.py +306 -0
- tb_rest_client/models/models_ce/change_password_request.py +154 -0
- tb_rest_client/models/models_ce/check_pre_provisioned_devices_device_profile_provision_configuration.py +104 -0
- tb_rest_client/models/models_ce/claim_request.py +124 -0
- tb_rest_client/models/models_ce/clear_rule.py +131 -0
- tb_rest_client/models/models_ce/client_attributes_querying_snmp_communication_config.py +156 -0
- tb_rest_client/models/models_ce/coap_device_profile_transport_configuration.py +156 -0
- tb_rest_client/models/models_ce/coap_device_transport_configuration.py +214 -0
- tb_rest_client/models/models_ce/coap_device_type_configuration.py +134 -0
- tb_rest_client/models/models_ce/column_mapping.py +156 -0
- tb_rest_client/models/models_ce/comparison_ts_value.py +150 -0
- tb_rest_client/models/models_ce/complex_filter_predicate.py +162 -0
- tb_rest_client/models/models_ce/complex_version_create_request.py +162 -0
- tb_rest_client/models/models_ce/component_descriptor.py +420 -0
- tb_rest_client/models/models_ce/component_descriptor_id.py +127 -0
- tb_rest_client/models/models_ce/config_submit_body.py +98 -0
- tb_rest_client/models/models_ce/custom_mobile_page.py +98 -0
- tb_rest_client/models/models_ce/custom_time_schedule.py +156 -0
- tb_rest_client/models/models_ce/custom_time_schedule_item.py +202 -0
- tb_rest_client/models/models_ce/customer.py +510 -0
- tb_rest_client/models/models_ce/customer_id.py +162 -0
- tb_rest_client/models/models_ce/customer_users_filter.py +131 -0
- tb_rest_client/models/models_ce/dashboard.py +399 -0
- tb_rest_client/models/models_ce/dashboard_id.py +162 -0
- tb_rest_client/models/models_ce/dashboard_info.py +373 -0
- tb_rest_client/models/models_ce/dashboard_page.py +98 -0
- tb_rest_client/models/models_ce/debug_converter_event_filter.py +351 -0
- tb_rest_client/models/models_ce/debug_integration_event_filter.py +325 -0
- tb_rest_client/models/models_ce/debug_rule_chain_event_filter.py +429 -0
- tb_rest_client/models/models_ce/debug_settings.py +182 -0
- tb_rest_client/models/models_ce/default_coap_device_type_configuration.py +130 -0
- tb_rest_client/models/models_ce/default_device_configuration.py +104 -0
- tb_rest_client/models/models_ce/default_device_profile_configuration.py +104 -0
- tb_rest_client/models/models_ce/default_device_profile_transport_configuration.py +104 -0
- tb_rest_client/models/models_ce/default_device_transport_configuration.py +104 -0
- tb_rest_client/models/models_ce/default_mobile_page.py +98 -0
- tb_rest_client/models/models_ce/default_rule_chain_create_request.py +127 -0
- tb_rest_client/models/models_ce/default_tenant_profile_configuration.py +1638 -0
- tb_rest_client/models/models_ce/deferred_result_entity_data_diff.py +150 -0
- tb_rest_client/models/models_ce/deferred_result_entity_data_info.py +150 -0
- tb_rest_client/models/models_ce/deferred_result_list_branch_info.py +150 -0
- tb_rest_client/models/models_ce/deferred_result_list_versioned_entity_info.py +150 -0
- tb_rest_client/models/models_ce/deferred_result_page_data_entity_version.py +150 -0
- tb_rest_client/models/models_ce/deferred_result_repository_settings.py +150 -0
- tb_rest_client/models/models_ce/deferred_result_response_entity.py +150 -0
- tb_rest_client/models/models_ce/deferred_result_void.py +150 -0
- tb_rest_client/models/models_ce/deferred_resultuuid.py +150 -0
- tb_rest_client/models/models_ce/delivery_method_notification_template.py +191 -0
- tb_rest_client/models/models_ce/device.py +446 -0
- tb_rest_client/models/models_ce/device_activity_notification_rule_trigger_config.py +190 -0
- tb_rest_client/models/models_ce/device_configuration.py +133 -0
- tb_rest_client/models/models_ce/device_credentials.py +293 -0
- tb_rest_client/models/models_ce/device_credentials_id.py +127 -0
- tb_rest_client/models/models_ce/device_data.py +154 -0
- tb_rest_client/models/models_ce/device_export_data.py +156 -0
- tb_rest_client/models/models_ce/device_id.py +162 -0
- tb_rest_client/models/models_ce/device_info.py +558 -0
- tb_rest_client/models/models_ce/device_profile.py +630 -0
- tb_rest_client/models/models_ce/device_profile_alarm.py +320 -0
- tb_rest_client/models/models_ce/device_profile_configuration.py +133 -0
- tb_rest_client/models/models_ce/device_profile_data.py +210 -0
- tb_rest_client/models/models_ce/device_profile_id.py +162 -0
- tb_rest_client/models/models_ce/device_profile_info.py +300 -0
- tb_rest_client/models/models_ce/device_profile_provision_configuration.py +162 -0
- tb_rest_client/models/models_ce/device_profile_transport_configuration.py +137 -0
- tb_rest_client/models/models_ce/device_search_query.py +180 -0
- tb_rest_client/models/models_ce/device_search_query_filter.py +266 -0
- tb_rest_client/models/models_ce/device_transport_configuration.py +137 -0
- tb_rest_client/models/models_ce/device_type_filter.py +182 -0
- tb_rest_client/models/models_ce/disabled_device_profile_provision_configuration.py +104 -0
- tb_rest_client/models/models_ce/domain.py +247 -0
- tb_rest_client/models/models_ce/domain_id.py +146 -0
- tb_rest_client/models/models_ce/domain_info.py +275 -0
- tb_rest_client/models/models_ce/duration_alarm_condition_spec.py +162 -0
- tb_rest_client/models/models_ce/dynamic_value_boolean.py +182 -0
- tb_rest_client/models/models_ce/dynamic_value_double.py +182 -0
- tb_rest_client/models/models_ce/dynamic_value_integer.py +182 -0
- tb_rest_client/models/models_ce/dynamic_value_long.py +182 -0
- tb_rest_client/models/models_ce/dynamic_value_string.py +182 -0
- tb_rest_client/models/models_ce/edge.py +426 -0
- tb_rest_client/models/models_ce/edge_communication_failure_notification_rule_trigger_config.py +130 -0
- tb_rest_client/models/models_ce/edge_connection_notification_rule_trigger_config.py +163 -0
- tb_rest_client/models/models_ce/edge_event.py +370 -0
- tb_rest_client/models/models_ce/edge_event_id.py +127 -0
- tb_rest_client/models/models_ce/edge_id.py +162 -0
- tb_rest_client/models/models_ce/edge_info.py +478 -0
- tb_rest_client/models/models_ce/edge_install_instructions.py +126 -0
- tb_rest_client/models/models_ce/edge_instructions.py +126 -0
- tb_rest_client/models/models_ce/edge_search_query.py +180 -0
- tb_rest_client/models/models_ce/edge_search_query_filter.py +266 -0
- tb_rest_client/models/models_ce/edge_type_filter.py +182 -0
- tb_rest_client/models/models_ce/efento_coap_device_type_configuration.py +104 -0
- tb_rest_client/models/models_ce/email_delivery_method_notification_template.py +131 -0
- tb_rest_client/models/models_ce/email_two_fa_account_config.py +131 -0
- tb_rest_client/models/models_ce/email_two_fa_provider_config.py +130 -0
- tb_rest_client/models/models_ce/entities_limit_notification_rule_trigger_config.py +163 -0
- tb_rest_client/models/models_ce/entity_action_notification_rule_trigger_config.py +215 -0
- tb_rest_client/models/models_ce/entity_count_query.py +150 -0
- tb_rest_client/models/models_ce/entity_data.py +202 -0
- tb_rest_client/models/models_ce/entity_data_diff.py +150 -0
- tb_rest_client/models/models_ce/entity_data_info.py +176 -0
- tb_rest_client/models/models_ce/entity_data_page_link.py +228 -0
- tb_rest_client/models/models_ce/entity_data_query.py +228 -0
- tb_rest_client/models/models_ce/entity_data_sort_order.py +156 -0
- tb_rest_client/models/models_ce/entity_export_data_object.py +219 -0
- tb_rest_client/models/models_ce/entity_filter.py +134 -0
- tb_rest_client/models/models_ce/entity_id.py +160 -0
- tb_rest_client/models/models_ce/entity_id_clearstart_timeend_time_body.py +98 -0
- tb_rest_client/models/models_ce/entity_info.py +152 -0
- tb_rest_client/models/models_ce/entity_key.py +156 -0
- tb_rest_client/models/models_ce/entity_list_filter.py +162 -0
- tb_rest_client/models/models_ce/entity_load_error.py +202 -0
- tb_rest_client/models/models_ce/entity_name_filter.py +162 -0
- tb_rest_client/models/models_ce/entity_relation.py +264 -0
- tb_rest_client/models/models_ce/entity_relation_info.py +320 -0
- tb_rest_client/models/models_ce/entity_relations_query.py +152 -0
- tb_rest_client/models/models_ce/entity_subtype.py +182 -0
- tb_rest_client/models/models_ce/entity_type_entity_idtenant_idpage_sizepagetext_searchsort_propertysort_orderstart_timeend_time_body.py +98 -0
- tb_rest_client/models/models_ce/entity_type_filter.py +136 -0
- tb_rest_client/models/models_ce/entity_type_load_result.py +208 -0
- tb_rest_client/models/models_ce/entity_type_version_create_config.py +260 -0
- tb_rest_client/models/models_ce/entity_type_version_load_config.py +228 -0
- tb_rest_client/models/models_ce/entity_type_version_load_request.py +156 -0
- tb_rest_client/models/models_ce/entity_version.py +202 -0
- tb_rest_client/models/models_ce/entity_view.py +423 -0
- tb_rest_client/models/models_ce/entity_view_id.py +162 -0
- tb_rest_client/models/models_ce/entity_view_info.py +479 -0
- tb_rest_client/models/models_ce/entity_view_search_query.py +180 -0
- tb_rest_client/models/models_ce/entity_view_search_query_filter.py +266 -0
- tb_rest_client/models/models_ce/entity_view_type_filter.py +182 -0
- tb_rest_client/models/models_ce/error_event_filter.py +188 -0
- tb_rest_client/models/models_ce/escalated_notification_rule_recipients_config.py +131 -0
- tb_rest_client/models/models_ce/event.py +286 -0
- tb_rest_client/models/models_ce/event_filter.py +171 -0
- tb_rest_client/models/models_ce/event_id.py +127 -0
- tb_rest_client/models/models_ce/event_info.py +286 -0
- tb_rest_client/models/models_ce/features_info.py +228 -0
- tb_rest_client/models/models_ce/file.py +488 -0
- tb_rest_client/models/models_ce/filter_predicate_value_boolean.py +176 -0
- tb_rest_client/models/models_ce/filter_predicate_value_double.py +176 -0
- tb_rest_client/models/models_ce/filter_predicate_value_integer.py +176 -0
- tb_rest_client/models/models_ce/filter_predicate_value_long.py +176 -0
- tb_rest_client/models/models_ce/filter_predicate_value_string.py +176 -0
- tb_rest_client/models/models_ce/has_id_object.py +124 -0
- tb_rest_client/models/models_ce/home_dashboard.py +427 -0
- tb_rest_client/models/models_ce/home_dashboard_info.py +152 -0
- tb_rest_client/models/models_ce/image_export_data.py +332 -0
- tb_rest_client/models/models_ce/inline_response200.py +99 -0
- tb_rest_client/models/models_ce/input_stream.py +98 -0
- tb_rest_client/models/models_ce/ios_config.py +176 -0
- tb_rest_client/models/models_ce/json_node.py +98 -0
- tb_rest_client/models/models_ce/json_transport_payload_configuration.py +104 -0
- tb_rest_client/models/models_ce/jwt_pair.py +186 -0
- tb_rest_client/models/models_ce/jwt_settings.py +210 -0
- tb_rest_client/models/models_ce/key_filter.py +182 -0
- tb_rest_client/models/models_ce/key_filter_predicate.py +136 -0
- tb_rest_client/models/models_ce/last_visited_dashboard_info.py +210 -0
- tb_rest_client/models/models_ce/life_cycle_event_filter.py +222 -0
- tb_rest_client/models/models_ce/login_mobile_info.py +176 -0
- tb_rest_client/models/models_ce/login_request.py +156 -0
- tb_rest_client/models/models_ce/login_response.py +156 -0
- tb_rest_client/models/models_ce/lw_m2_m_bootstrap_server_credential.py +136 -0
- tb_rest_client/models/models_ce/lw_m2_m_server_security_config_default.py +490 -0
- tb_rest_client/models/models_ce/lw_m2m_instance.py +154 -0
- tb_rest_client/models/models_ce/lw_m2m_object.py +266 -0
- tb_rest_client/models/models_ce/lw_m2m_resource_observe.py +266 -0
- tb_rest_client/models/models_ce/lw_m2m_version.py +124 -0
- tb_rest_client/models/models_ce/lwm2m_device_profile_transport_configuration.py +208 -0
- tb_rest_client/models/models_ce/lwm2m_device_transport_configuration.py +214 -0
- tb_rest_client/models/models_ce/mapping.py +202 -0
- tb_rest_client/models/models_ce/microsoft_teams_delivery_method_notification_template.py +182 -0
- tb_rest_client/models/models_ce/microsoft_teams_notification_target_config.py +314 -0
- tb_rest_client/models/models_ce/mobile_app.py +290 -0
- tb_rest_client/models/models_ce/mobile_app_bundle.py +375 -0
- tb_rest_client/models/models_ce/mobile_app_bundle_id.py +154 -0
- tb_rest_client/models/models_ce/mobile_app_bundle_info.py +487 -0
- tb_rest_client/models/models_ce/mobile_app_delivery_method_notification_template.py +157 -0
- tb_rest_client/models/models_ce/mobile_app_id.py +160 -0
- tb_rest_client/models/models_ce/mobile_app_info.py +318 -0
- tb_rest_client/models/models_ce/mobile_app_notification_delivery_method_config.py +157 -0
- tb_rest_client/models/models_ce/mobile_app_settings.py +352 -0
- tb_rest_client/models/models_ce/mobile_app_settings_id.py +127 -0
- tb_rest_client/models/models_ce/mobile_app_version_info.py +210 -0
- tb_rest_client/models/models_ce/mobile_layout_config.py +126 -0
- tb_rest_client/models/models_ce/mobile_page.py +158 -0
- tb_rest_client/models/models_ce/mobile_session_info.py +124 -0
- tb_rest_client/models/models_ce/mqtt_device_profile_transport_configuration.py +286 -0
- tb_rest_client/models/models_ce/mqtt_device_transport_configuration.py +104 -0
- tb_rest_client/models/models_ce/new_platform_version_notification_rule_trigger_config.py +104 -0
- tb_rest_client/models/models_ce/no_sec_lw_m2_m_bootstrap_server_credential.py +440 -0
- tb_rest_client/models/models_ce/node_connection_info.py +185 -0
- tb_rest_client/models/models_ce/notification.py +402 -0
- tb_rest_client/models/models_ce/notification_delivery_method_config.py +134 -0
- tb_rest_client/models/models_ce/notification_id.py +162 -0
- tb_rest_client/models/models_ce/notification_info.py +185 -0
- tb_rest_client/models/models_ce/notification_pref.py +151 -0
- tb_rest_client/models/models_ce/notification_request.py +417 -0
- tb_rest_client/models/models_ce/notification_request_config.py +124 -0
- tb_rest_client/models/models_ce/notification_request_id.py +162 -0
- tb_rest_client/models/models_ce/notification_request_info.py +476 -0
- tb_rest_client/models/models_ce/notification_request_preview.py +202 -0
- tb_rest_client/models/models_ce/notification_request_stats.py +202 -0
- tb_rest_client/models/models_ce/notification_rule.py +369 -0
- tb_rest_client/models/models_ce/notification_rule_config.py +124 -0
- tb_rest_client/models/models_ce/notification_rule_id.py +162 -0
- tb_rest_client/models/models_ce/notification_rule_info.py +428 -0
- tb_rest_client/models/models_ce/notification_rule_recipients_config.py +139 -0
- tb_rest_client/models/models_ce/notification_rule_trigger_config.py +178 -0
- tb_rest_client/models/models_ce/notification_settings.py +125 -0
- tb_rest_client/models/models_ce/notification_target.py +230 -0
- tb_rest_client/models/models_ce/notification_target_config.py +148 -0
- tb_rest_client/models/models_ce/notification_target_id.py +162 -0
- tb_rest_client/models/models_ce/notification_template.py +263 -0
- tb_rest_client/models/models_ce/notification_template_config.py +125 -0
- tb_rest_client/models/models_ce/notification_template_id.py +162 -0
- tb_rest_client/models/models_ce/numeric_filter_predicate.py +162 -0
- tb_rest_client/models/models_ce/o_auth2_basic_mapper_config.py +329 -0
- tb_rest_client/models/models_ce/o_auth2_client.py +636 -0
- tb_rest_client/models/models_ce/o_auth2_client_id.py +160 -0
- tb_rest_client/models/models_ce/o_auth2_client_info.py +267 -0
- tb_rest_client/models/models_ce/o_auth2_client_login_info.py +182 -0
- tb_rest_client/models/models_ce/o_auth2_client_registration_template.py +565 -0
- tb_rest_client/models/models_ce/o_auth2_client_registration_template_id.py +127 -0
- tb_rest_client/models/models_ce/o_auth2_custom_mapper_config.py +202 -0
- tb_rest_client/models/models_ce/o_auth2_domain_info.py +162 -0
- tb_rest_client/models/models_ce/o_auth2_info.py +183 -0
- tb_rest_client/models/models_ce/o_auth2_mapper_config.py +241 -0
- tb_rest_client/models/models_ce/o_auth2_mobile_info.py +156 -0
- tb_rest_client/models/models_ce/o_auth2_params_info.py +185 -0
- tb_rest_client/models/models_ce/o_auth2_registration_info.py +502 -0
- tb_rest_client/models/models_ce/object_attributes.py +410 -0
- tb_rest_client/models/models_ce/object_node.py +98 -0
- tb_rest_client/models/models_ce/one_of_alarm_condition_filter_predicate.py +98 -0
- tb_rest_client/models/models_ce/one_of_alarm_condition_spec.py +98 -0
- tb_rest_client/models/models_ce/one_of_alarm_count_query_entity_filter.py +98 -0
- tb_rest_client/models/models_ce/one_of_alarm_data_query_entity_filter.py +98 -0
- tb_rest_client/models/models_ce/one_of_alarm_rule_schedule.py +98 -0
- tb_rest_client/models/models_ce/one_of_device_data_configuration.py +98 -0
- tb_rest_client/models/models_ce/one_of_device_data_transport_configuration.py +98 -0
- tb_rest_client/models/models_ce/one_of_device_profile_data_configuration.py +98 -0
- tb_rest_client/models/models_ce/one_of_device_profile_data_provision_configuration.py +98 -0
- tb_rest_client/models/models_ce/one_of_device_profile_data_transport_configuration.py +98 -0
- tb_rest_client/models/models_ce/one_of_entity_count_query_entity_filter.py +98 -0
- tb_rest_client/models/models_ce/one_of_entity_data_diff_current_version.py +98 -0
- tb_rest_client/models/models_ce/one_of_entity_data_diff_other_version.py +98 -0
- tb_rest_client/models/models_ce/one_of_entity_data_query_entity_filter.py +98 -0
- tb_rest_client/models/models_ce/one_of_key_filter_predicate.py +98 -0
- tb_rest_client/models/models_ce/one_of_notification_rule_info_recipients_config.py +98 -0
- tb_rest_client/models/models_ce/one_of_notification_rule_info_trigger_config.py +98 -0
- tb_rest_client/models/models_ce/one_of_notification_rule_recipients_config.py +98 -0
- tb_rest_client/models/models_ce/one_of_notification_rule_trigger_config.py +98 -0
- tb_rest_client/models/models_ce/one_of_notification_target_configuration.py +98 -0
- tb_rest_client/models/models_ce/one_of_platform_two_fa_settings_providers_items.py +98 -0
- tb_rest_client/models/models_ce/one_of_tenant_profile_data_configuration.py +98 -0
- tb_rest_client/models/models_ce/one_of_test_sms_request_provider_configuration.py +98 -0
- tb_rest_client/models/models_ce/originator_entity_owner_users_filter.py +104 -0
- tb_rest_client/models/models_ce/ota_package.py +576 -0
- tb_rest_client/models/models_ce/ota_package_data.py +306 -0
- tb_rest_client/models/models_ce/ota_package_id.py +162 -0
- tb_rest_client/models/models_ce/ota_package_info.py +550 -0
- tb_rest_client/models/models_ce/ota_package_ota_package_idchecksumchecksum_algorithm_body.py +127 -0
- tb_rest_client/models/models_ce/other_configuration.py +364 -0
- tb_rest_client/models/models_ce/page_data_alarm_comment_info.py +210 -0
- tb_rest_client/models/models_ce/page_data_alarm_data.py +210 -0
- tb_rest_client/models/models_ce/page_data_alarm_info.py +210 -0
- tb_rest_client/models/models_ce/page_data_asset.py +210 -0
- tb_rest_client/models/models_ce/page_data_asset_info.py +210 -0
- tb_rest_client/models/models_ce/page_data_asset_profile.py +210 -0
- tb_rest_client/models/models_ce/page_data_asset_profile_info.py +210 -0
- tb_rest_client/models/models_ce/page_data_audit_log.py +210 -0
- tb_rest_client/models/models_ce/page_data_customer.py +210 -0
- tb_rest_client/models/models_ce/page_data_dashboard_info.py +210 -0
- tb_rest_client/models/models_ce/page_data_device.py +210 -0
- tb_rest_client/models/models_ce/page_data_device_info.py +210 -0
- tb_rest_client/models/models_ce/page_data_device_profile.py +210 -0
- tb_rest_client/models/models_ce/page_data_device_profile_info.py +210 -0
- tb_rest_client/models/models_ce/page_data_domain_info.py +210 -0
- tb_rest_client/models/models_ce/page_data_edge.py +210 -0
- tb_rest_client/models/models_ce/page_data_edge_event.py +210 -0
- tb_rest_client/models/models_ce/page_data_edge_info.py +210 -0
- tb_rest_client/models/models_ce/page_data_entity_data.py +210 -0
- tb_rest_client/models/models_ce/page_data_entity_info.py +210 -0
- tb_rest_client/models/models_ce/page_data_entity_subtype.py +210 -0
- tb_rest_client/models/models_ce/page_data_entity_version.py +210 -0
- tb_rest_client/models/models_ce/page_data_entity_view.py +210 -0
- tb_rest_client/models/models_ce/page_data_entity_view_info.py +210 -0
- tb_rest_client/models/models_ce/page_data_event.py +210 -0
- tb_rest_client/models/models_ce/page_data_event_info.py +210 -0
- tb_rest_client/models/models_ce/page_data_mobile_app.py +210 -0
- tb_rest_client/models/models_ce/page_data_mobile_app_bundle_info.py +196 -0
- tb_rest_client/models/models_ce/page_data_mobile_app_info.py +210 -0
- tb_rest_client/models/models_ce/page_data_notification.py +210 -0
- tb_rest_client/models/models_ce/page_data_notification_request_info.py +210 -0
- tb_rest_client/models/models_ce/page_data_notification_rule_info.py +210 -0
- tb_rest_client/models/models_ce/page_data_notification_target.py +210 -0
- tb_rest_client/models/models_ce/page_data_notification_template.py +210 -0
- tb_rest_client/models/models_ce/page_data_o_auth2_client_info.py +210 -0
- tb_rest_client/models/models_ce/page_data_ota_package_info.py +210 -0
- tb_rest_client/models/models_ce/page_data_queue.py +210 -0
- tb_rest_client/models/models_ce/page_data_queue_stats.py +210 -0
- tb_rest_client/models/models_ce/page_data_rpc.py +202 -0
- tb_rest_client/models/models_ce/page_data_rule_chain.py +210 -0
- tb_rest_client/models/models_ce/page_data_tb_resource_info.py +210 -0
- tb_rest_client/models/models_ce/page_data_tenant.py +210 -0
- tb_rest_client/models/models_ce/page_data_tenant_info.py +210 -0
- tb_rest_client/models/models_ce/page_data_tenant_profile.py +210 -0
- tb_rest_client/models/models_ce/page_data_user.py +210 -0
- tb_rest_client/models/models_ce/page_data_user_email_info.py +210 -0
- tb_rest_client/models/models_ce/page_data_widget_type_info.py +210 -0
- tb_rest_client/models/models_ce/page_data_widgets_bundle.py +210 -0
- tb_rest_client/models/models_ce/platform_two_fa_settings.py +231 -0
- tb_rest_client/models/models_ce/platform_users_notification_target_config.py +131 -0
- tb_rest_client/models/models_ce/power_saving_configuration.py +208 -0
- tb_rest_client/models/models_ce/processing_strategy.py +234 -0
- tb_rest_client/models/models_ce/proto_transport_payload_configuration.py +260 -0
- tb_rest_client/models/models_ce/psklw_m2_m_bootstrap_server_credential.py +440 -0
- tb_rest_client/models/models_ce/qr_code_config.py +234 -0
- tb_rest_client/models/models_ce/qr_code_settings.py +399 -0
- tb_rest_client/models/models_ce/qr_code_settings_id.py +127 -0
- tb_rest_client/models/models_ce/queue.py +410 -0
- tb_rest_client/models/models_ce/queue_id.py +162 -0
- tb_rest_client/models/models_ce/queue_stats.py +228 -0
- tb_rest_client/models/models_ce/queue_stats_id.py +162 -0
- tb_rest_client/models/models_ce/rate_limits_notification_rule_trigger_config.py +137 -0
- tb_rest_client/models/models_ce/relation_entity_type_filter.py +189 -0
- tb_rest_client/models/models_ce/relations_query_filter.py +350 -0
- tb_rest_client/models/models_ce/relations_search_parameters.py +284 -0
- tb_rest_client/models/models_ce/repeating_alarm_condition_spec.py +130 -0
- tb_rest_client/models/models_ce/repository_settings.py +390 -0
- tb_rest_client/models/models_ce/repository_settings_info.py +150 -0
- tb_rest_client/models/models_ce/reset_password_email_request.py +126 -0
- tb_rest_client/models/models_ce/reset_password_request.py +154 -0
- tb_rest_client/models/models_ce/resource.py +306 -0
- tb_rest_client/models/models_ce/resource_export_data.py +384 -0
- tb_rest_client/models/models_ce/response_entity.py +182 -0
- tb_rest_client/models/models_ce/rpc.py +344 -0
- tb_rest_client/models/models_ce/rpc_id.py +162 -0
- tb_rest_client/models/models_ce/rpklw_m2_m_bootstrap_server_credential.py +440 -0
- tb_rest_client/models/models_ce/rule_chain.py +402 -0
- tb_rest_client/models/models_ce/rule_chain_connection_info.py +210 -0
- tb_rest_client/models/models_ce/rule_chain_data.py +156 -0
- tb_rest_client/models/models_ce/rule_chain_debug_event_filter.py +240 -0
- tb_rest_client/models/models_ce/rule_chain_export_data.py +156 -0
- tb_rest_client/models/models_ce/rule_chain_id.py +162 -0
- tb_rest_client/models/models_ce/rule_chain_import_result.py +202 -0
- tb_rest_client/models/models_ce/rule_chain_meta_data.py +269 -0
- tb_rest_client/models/models_ce/rule_chain_output_labels_usage.py +239 -0
- tb_rest_client/models/models_ce/rule_engine_component_lifecycle_event_notification_rule_trigger_config.py +274 -0
- tb_rest_client/models/models_ce/rule_node.py +424 -0
- tb_rest_client/models/models_ce/rule_node_debug_event_filter.py +448 -0
- tb_rest_client/models/models_ce/rule_node_id.py +162 -0
- tb_rest_client/models/models_ce/save_device_with_credentials_request.py +152 -0
- tb_rest_client/models/models_ce/save_ota_package_info_request.py +578 -0
- tb_rest_client/models/models_ce/security_settings.py +266 -0
- tb_rest_client/models/models_ce/server_security_config.py +332 -0
- tb_rest_client/models/models_ce/shared_attributes_setting_snmp_communication_config.py +130 -0
- tb_rest_client/models/models_ce/short_customer_info.py +204 -0
- tb_rest_client/models/models_ce/sign_up_request.py +294 -0
- tb_rest_client/models/models_ce/simple_alarm_condition_spec.py +104 -0
- tb_rest_client/models/models_ce/single_entity_filter.py +130 -0
- tb_rest_client/models/models_ce/single_entity_version_create_request.py +156 -0
- tb_rest_client/models/models_ce/single_entity_version_load_request.py +156 -0
- tb_rest_client/models/models_ce/slack_conversation.py +263 -0
- tb_rest_client/models/models_ce/slack_delivery_method_notification_template.py +104 -0
- tb_rest_client/models/models_ce/slack_notification_delivery_method_config.py +131 -0
- tb_rest_client/models/models_ce/slack_notification_target_config.py +163 -0
- tb_rest_client/models/models_ce/smpp_sms_provider_configuration.py +541 -0
- tb_rest_client/models/models_ce/sms_delivery_method_notification_template.py +104 -0
- tb_rest_client/models/models_ce/sms_provider_configuration.py +135 -0
- tb_rest_client/models/models_ce/sms_two_fa_account_config.py +131 -0
- tb_rest_client/models/models_ce/sms_two_fa_provider_config.py +157 -0
- tb_rest_client/models/models_ce/snmp_communication_config.py +142 -0
- tb_rest_client/models/models_ce/snmp_device_profile_transport_configuration.py +182 -0
- tb_rest_client/models/models_ce/snmp_device_transport_configuration.py +434 -0
- tb_rest_client/models/models_ce/snmp_mapping.py +182 -0
- tb_rest_client/models/models_ce/specific_time_schedule.py +208 -0
- tb_rest_client/models/models_ce/starred_dashboard_info.py +182 -0
- tb_rest_client/models/models_ce/statistics_event_filter.py +244 -0
- tb_rest_client/models/models_ce/store_info.py +176 -0
- tb_rest_client/models/models_ce/string_filter_predicate.py +188 -0
- tb_rest_client/models/models_ce/submit_strategy.py +156 -0
- tb_rest_client/models/models_ce/system_administrators_filter.py +104 -0
- tb_rest_client/models/models_ce/system_info.py +152 -0
- tb_rest_client/models/models_ce/system_info_data.py +322 -0
- tb_rest_client/models/models_ce/task_processing_failure_notification_rule_trigger_config.py +104 -0
- tb_rest_client/models/models_ce/tb_image_delete_result.py +150 -0
- tb_rest_client/models/models_ce/tb_resource.py +568 -0
- tb_rest_client/models/models_ce/tb_resource_id.py +162 -0
- tb_rest_client/models/models_ce/tb_resource_info.py +514 -0
- tb_rest_client/models/models_ce/telemetry_entity_view.py +154 -0
- tb_rest_client/models/models_ce/telemetry_mapping_configuration.py +228 -0
- tb_rest_client/models/models_ce/telemetry_querying_snmp_communication_config.py +156 -0
- tb_rest_client/models/models_ce/tenant.py +539 -0
- tb_rest_client/models/models_ce/tenant_administrators_filter.py +156 -0
- tb_rest_client/models/models_ce/tenant_id.py +162 -0
- tb_rest_client/models/models_ce/tenant_info.py +567 -0
- tb_rest_client/models/models_ce/tenant_profile.py +288 -0
- tb_rest_client/models/models_ce/tenant_profile_configuration.py +133 -0
- tb_rest_client/models/models_ce/tenant_profile_data.py +154 -0
- tb_rest_client/models/models_ce/tenant_profile_id.py +162 -0
- tb_rest_client/models/models_ce/tenant_profile_queue_configuration.py +332 -0
- tb_rest_client/models/models_ce/test_sms_request.py +182 -0
- tb_rest_client/models/models_ce/thingsboard_credentials_expired_response.py +238 -0
- tb_rest_client/models/models_ce/thingsboard_error_response.py +210 -0
- tb_rest_client/models/models_ce/to_device_rpc_request_snmp_communication_config.py +130 -0
- tb_rest_client/models/models_ce/to_server_rpc_request_snmp_communication_config.py +130 -0
- tb_rest_client/models/models_ce/totp_two_fa_account_config.py +131 -0
- tb_rest_client/models/models_ce/totp_two_fa_provider_config.py +131 -0
- tb_rest_client/models/models_ce/transport_payload_type_configuration.py +134 -0
- tb_rest_client/models/models_ce/ts_value.py +176 -0
- tb_rest_client/models/models_ce/twilio_sms_provider_configuration.py +188 -0
- tb_rest_client/models/models_ce/two_fa_account_config.py +162 -0
- tb_rest_client/models/models_ce/two_fa_account_config_update_request.py +124 -0
- tb_rest_client/models/models_ce/two_fa_provider_config.py +136 -0
- tb_rest_client/models/models_ce/two_fa_provider_info.py +234 -0
- tb_rest_client/models/models_ce/type_key_body.py +125 -0
- tb_rest_client/models/models_ce/update_message.py +266 -0
- tb_rest_client/models/models_ce/usage_info.py +696 -0
- tb_rest_client/models/models_ce/user.py +432 -0
- tb_rest_client/models/models_ce/user_activation_link.py +150 -0
- tb_rest_client/models/models_ce/user_dashboards_info.py +154 -0
- tb_rest_client/models/models_ce/user_email_info.py +208 -0
- tb_rest_client/models/models_ce/user_id.py +162 -0
- tb_rest_client/models/models_ce/user_list_filter.py +131 -0
- tb_rest_client/models/models_ce/user_mobile_info.py +228 -0
- tb_rest_client/models/models_ce/user_notification_settings.py +125 -0
- tb_rest_client/models/models_ce/user_password_policy.py +378 -0
- tb_rest_client/models/models_ce/users_filter.py +140 -0
- tb_rest_client/models/models_ce/vc_entity_body.py +98 -0
- tb_rest_client/models/models_ce/vc_version_body.py +98 -0
- tb_rest_client/models/models_ce/version.py +98 -0
- tb_rest_client/models/models_ce/version_create_config.py +176 -0
- tb_rest_client/models/models_ce/version_create_request.py +191 -0
- tb_rest_client/models/models_ce/version_creation_result.py +254 -0
- tb_rest_client/models/models_ce/version_load_config.py +176 -0
- tb_rest_client/models/models_ce/version_load_request.py +165 -0
- tb_rest_client/models/models_ce/version_load_result.py +176 -0
- tb_rest_client/models/models_ce/versioned_entity_info.py +124 -0
- tb_rest_client/models/models_ce/web_delivery_method_notification_template.py +157 -0
- tb_rest_client/models/models_ce/web_view_page.py +98 -0
- tb_rest_client/models/models_ce/widget_type.py +342 -0
- tb_rest_client/models/models_ce/widget_type_details.py +426 -0
- tb_rest_client/models/models_ce/widget_type_export_data.py +130 -0
- tb_rest_client/models/models_ce/widget_type_id.py +162 -0
- tb_rest_client/models/models_ce/widget_type_info.py +428 -0
- tb_rest_client/models/models_ce/widgets_bundle.py +400 -0
- tb_rest_client/models/models_ce/widgets_bundle_export_data.py +182 -0
- tb_rest_client/models/models_ce/widgets_bundle_id.py +162 -0
- tb_rest_client/models/models_ce/x509_certificate_chain_provision_configuration.py +156 -0
- tb_rest_client/models/models_ce/x509_lw_m2_m_bootstrap_server_credential.py +440 -0
- tb_rest_client/models/models_pe/__init__.py +413 -0
- tb_rest_client/models/models_pe/account_two_fa_settings.py +124 -0
- tb_rest_client/models/models_pe/activate_user_request.py +154 -0
- tb_rest_client/models/models_pe/admin_settings.py +232 -0
- tb_rest_client/models/models_pe/admin_settings_id.py +127 -0
- tb_rest_client/models/models_pe/affected_tenant_administrators_filter.py +104 -0
- tb_rest_client/models/models_pe/affected_user_filter.py +104 -0
- tb_rest_client/models/models_pe/alarm.py +749 -0
- tb_rest_client/models/models_pe/alarm_assignee.py +202 -0
- tb_rest_client/models/models_pe/alarm_assignment_notification_rule_trigger_config.py +230 -0
- tb_rest_client/models/models_pe/alarm_comment.py +292 -0
- tb_rest_client/models/models_pe/alarm_comment_id.py +127 -0
- tb_rest_client/models/models_pe/alarm_comment_info.py +376 -0
- tb_rest_client/models/models_pe/alarm_comment_notification_rule_trigger_config.py +248 -0
- tb_rest_client/models/models_pe/alarm_condition.py +154 -0
- tb_rest_client/models/models_pe/alarm_condition_filter.py +214 -0
- tb_rest_client/models/models_pe/alarm_condition_filter_key.py +160 -0
- tb_rest_client/models/models_pe/alarm_condition_spec.py +135 -0
- tb_rest_client/models/models_pe/alarm_count_query.py +372 -0
- tb_rest_client/models/models_pe/alarm_data.py +883 -0
- tb_rest_client/models/models_pe/alarm_data_page_link.py +450 -0
- tb_rest_client/models/models_pe/alarm_data_query.py +254 -0
- tb_rest_client/models/models_pe/alarm_id.py +162 -0
- tb_rest_client/models/models_pe/alarm_info.py +831 -0
- tb_rest_client/models/models_pe/alarm_notification_rule_trigger_config.py +223 -0
- tb_rest_client/models/models_pe/alarm_rule.py +206 -0
- tb_rest_client/models/models_pe/alarm_schedule.py +152 -0
- tb_rest_client/models/models_pe/all_users_filter.py +104 -0
- tb_rest_client/models/models_pe/allow_create_new_devices_device_profile_provision_configuration.py +104 -0
- tb_rest_client/models/models_pe/allowed_permissions_info.py +318 -0
- tb_rest_client/models/models_pe/any_time_schedule.py +104 -0
- tb_rest_client/models/models_pe/api_usage_limit_notification_rule_trigger_config.py +170 -0
- tb_rest_client/models/models_pe/api_usage_state_filter.py +130 -0
- tb_rest_client/models/models_pe/array_node.py +98 -0
- tb_rest_client/models/models_pe/asset.py +393 -0
- tb_rest_client/models/models_pe/asset_id.py +162 -0
- tb_rest_client/models/models_pe/asset_info.py +449 -0
- tb_rest_client/models/models_pe/asset_profile_id.py +162 -0
- tb_rest_client/models/models_pe/asset_search_query.py +180 -0
- tb_rest_client/models/models_pe/asset_search_query_filter.py +266 -0
- tb_rest_client/models/models_pe/asset_type_filter.py +182 -0
- tb_rest_client/models/models_pe/atomic_integer.py +228 -0
- tb_rest_client/models/models_pe/attribute_export_data.py +280 -0
- tb_rest_client/models/models_pe/attributes_entity_view.py +185 -0
- tb_rest_client/models/models_pe/audit_log.py +434 -0
- tb_rest_client/models/models_pe/audit_log_id.py +127 -0
- tb_rest_client/models/models_pe/auto_version_create_config.py +254 -0
- tb_rest_client/models/models_pe/aws_sns_sms_provider_configuration.py +188 -0
- tb_rest_client/models/models_pe/backup_code_two_fa_account_config.py +157 -0
- tb_rest_client/models/models_pe/backup_code_two_fa_provider_config.py +130 -0
- tb_rest_client/models/models_pe/blob_entity_id.py +162 -0
- tb_rest_client/models/models_pe/blob_entity_info.py +346 -0
- tb_rest_client/models/models_pe/blob_entity_with_customer_info.py +402 -0
- tb_rest_client/models/models_pe/boolean_filter_predicate.py +162 -0
- tb_rest_client/models/models_pe/branch_info.py +150 -0
- tb_rest_client/models/models_pe/bulk_import_request.py +202 -0
- tb_rest_client/models/models_pe/bulk_import_result_asset.py +202 -0
- tb_rest_client/models/models_pe/bulk_import_result_device.py +202 -0
- tb_rest_client/models/models_pe/bulk_import_result_edge.py +202 -0
- tb_rest_client/models/models_pe/byte_buffer.py +306 -0
- tb_rest_client/models/models_pe/captcha_params.py +132 -0
- tb_rest_client/models/models_pe/change_password_request.py +154 -0
- tb_rest_client/models/models_pe/check_pre_provisioned_devices_device_profile_provision_configuration.py +104 -0
- tb_rest_client/models/models_pe/claim_request.py +124 -0
- tb_rest_client/models/models_pe/clear_rule.py +131 -0
- tb_rest_client/models/models_pe/client_attributes_querying_snmp_communication_config.py +156 -0
- tb_rest_client/models/models_pe/coap_device_profile_transport_configuration.py +156 -0
- tb_rest_client/models/models_pe/coap_device_transport_configuration.py +214 -0
- tb_rest_client/models/models_pe/coap_device_type_configuration.py +134 -0
- tb_rest_client/models/models_pe/column_mapping.py +156 -0
- tb_rest_client/models/models_pe/comparison_ts_value.py +150 -0
- tb_rest_client/models/models_pe/complex_filter_predicate.py +162 -0
- tb_rest_client/models/models_pe/complex_version_create_request.py +162 -0
- tb_rest_client/models/models_pe/component_descriptor.py +420 -0
- tb_rest_client/models/models_pe/component_descriptor_id.py +127 -0
- tb_rest_client/models/models_pe/contact_based_object.py +410 -0
- tb_rest_client/models/models_pe/converter.py +376 -0
- tb_rest_client/models/models_pe/converter_id.py +162 -0
- tb_rest_client/models/models_pe/converters_info.py +136 -0
- tb_rest_client/models/models_pe/custom_menu.py +327 -0
- tb_rest_client/models/models_pe/custom_menu_config.py +113 -0
- tb_rest_client/models/models_pe/custom_menu_delete_result.py +168 -0
- tb_rest_client/models/models_pe/custom_menu_id.py +113 -0
- tb_rest_client/models/models_pe/custom_menu_info.py +287 -0
- tb_rest_client/models/models_pe/custom_menu_item.py +398 -0
- tb_rest_client/models/models_pe/custom_time_schedule.py +156 -0
- tb_rest_client/models/models_pe/custom_time_schedule_item.py +202 -0
- tb_rest_client/models/models_pe/custom_translation.py +127 -0
- tb_rest_client/models/models_pe/customer_id.py +162 -0
- tb_rest_client/models/models_pe/customer_info.py +672 -0
- tb_rest_client/models/models_pe/customer_users_filter.py +131 -0
- tb_rest_client/models/models_pe/dashboard_id.py +162 -0
- tb_rest_client/models/models_pe/dashboard_info.py +506 -0
- tb_rest_client/models/models_pe/debug_converter_event_filter.py +316 -0
- tb_rest_client/models/models_pe/debug_integration_event_filter.py +290 -0
- tb_rest_client/models/models_pe/default_coap_device_type_configuration.py +130 -0
- tb_rest_client/models/models_pe/default_dashboard_params.py +154 -0
- tb_rest_client/models/models_pe/default_device_configuration.py +104 -0
- tb_rest_client/models/models_pe/default_device_profile_configuration.py +104 -0
- tb_rest_client/models/models_pe/default_device_profile_transport_configuration.py +104 -0
- tb_rest_client/models/models_pe/default_device_transport_configuration.py +104 -0
- tb_rest_client/models/models_pe/default_menu_item.py +230 -0
- tb_rest_client/models/models_pe/default_rule_chain_create_request.py +127 -0
- tb_rest_client/models/models_pe/default_tenant_profile_configuration.py +1794 -0
- tb_rest_client/models/models_pe/deferred_result_entity_data_diff.py +150 -0
- tb_rest_client/models/models_pe/deferred_result_entity_data_info.py +150 -0
- tb_rest_client/models/models_pe/deferred_result_list_branch_info.py +150 -0
- tb_rest_client/models/models_pe/deferred_result_list_versioned_entity_info.py +150 -0
- tb_rest_client/models/models_pe/deferred_result_page_data_entity_version.py +150 -0
- tb_rest_client/models/models_pe/deferred_result_repository_settings.py +150 -0
- tb_rest_client/models/models_pe/deferred_result_void.py +150 -0
- tb_rest_client/models/models_pe/deferred_resultuuid.py +150 -0
- tb_rest_client/models/models_pe/delivery_method_notification_template.py +191 -0
- tb_rest_client/models/models_pe/device.py +471 -0
- tb_rest_client/models/models_pe/device_activity_notification_rule_trigger_config.py +190 -0
- tb_rest_client/models/models_pe/device_configuration.py +133 -0
- tb_rest_client/models/models_pe/device_credentials_id.py +127 -0
- tb_rest_client/models/models_pe/device_data.py +154 -0
- tb_rest_client/models/models_pe/device_export_data.py +156 -0
- tb_rest_client/models/models_pe/device_group_ota_package.py +234 -0
- tb_rest_client/models/models_pe/device_id.py +162 -0
- tb_rest_client/models/models_pe/device_info.py +555 -0
- tb_rest_client/models/models_pe/device_profile_alarm.py +348 -0
- tb_rest_client/models/models_pe/device_profile_configuration.py +133 -0
- tb_rest_client/models/models_pe/device_profile_data.py +210 -0
- tb_rest_client/models/models_pe/device_profile_id.py +162 -0
- tb_rest_client/models/models_pe/device_profile_provision_configuration.py +162 -0
- tb_rest_client/models/models_pe/device_profile_transport_configuration.py +137 -0
- tb_rest_client/models/models_pe/device_search_query.py +180 -0
- tb_rest_client/models/models_pe/device_search_query_filter.py +266 -0
- tb_rest_client/models/models_pe/device_transport_configuration.py +137 -0
- tb_rest_client/models/models_pe/device_type_filter.py +182 -0
- tb_rest_client/models/models_pe/disabled_device_profile_provision_configuration.py +104 -0
- tb_rest_client/models/models_pe/duration_alarm_condition_spec.py +162 -0
- tb_rest_client/models/models_pe/edge.py +510 -0
- tb_rest_client/models/models_pe/edge_communication_failure_notification_rule_trigger_config.py +130 -0
- tb_rest_client/models/models_pe/edge_connection_notification_rule_trigger_config.py +163 -0
- tb_rest_client/models/models_pe/edge_event.py +396 -0
- tb_rest_client/models/models_pe/edge_event_id.py +127 -0
- tb_rest_client/models/models_pe/edge_id.py +162 -0
- tb_rest_client/models/models_pe/edge_info.py +566 -0
- tb_rest_client/models/models_pe/edge_instructions.py +126 -0
- tb_rest_client/models/models_pe/edge_search_query.py +180 -0
- tb_rest_client/models/models_pe/edge_search_query_filter.py +266 -0
- tb_rest_client/models/models_pe/edge_type_filter.py +168 -0
- tb_rest_client/models/models_pe/efento_coap_device_type_configuration.py +104 -0
- tb_rest_client/models/models_pe/email_delivery_method_notification_template.py +131 -0
- tb_rest_client/models/models_pe/email_two_fa_account_config.py +131 -0
- tb_rest_client/models/models_pe/email_two_fa_provider_config.py +130 -0
- tb_rest_client/models/models_pe/enterprise_captcha_params.py +98 -0
- tb_rest_client/models/models_pe/entities_by_group_name_filter.py +188 -0
- tb_rest_client/models/models_pe/entities_limit_notification_rule_trigger_config.py +163 -0
- tb_rest_client/models/models_pe/entity_action_notification_rule_trigger_config.py +215 -0
- tb_rest_client/models/models_pe/entity_count_query.py +150 -0
- tb_rest_client/models/models_pe/entity_data.py +254 -0
- tb_rest_client/models/models_pe/entity_data_diff.py +150 -0
- tb_rest_client/models/models_pe/entity_data_info.py +228 -0
- tb_rest_client/models/models_pe/entity_data_page_link.py +228 -0
- tb_rest_client/models/models_pe/entity_data_query.py +228 -0
- tb_rest_client/models/models_pe/entity_data_sort_order.py +156 -0
- tb_rest_client/models/models_pe/entity_export_data_object.py +210 -0
- tb_rest_client/models/models_pe/entity_filter.py +152 -0
- tb_rest_client/models/models_pe/entity_group.py +400 -0
- tb_rest_client/models/models_pe/entity_group_export_data.py +182 -0
- tb_rest_client/models/models_pe/entity_group_filter.py +162 -0
- tb_rest_client/models/models_pe/entity_group_id.py +162 -0
- tb_rest_client/models/models_pe/entity_group_info.py +429 -0
- tb_rest_client/models/models_pe/entity_group_list_filter.py +162 -0
- tb_rest_client/models/models_pe/entity_group_name_filter.py +162 -0
- tb_rest_client/models/models_pe/entity_id.py +160 -0
- tb_rest_client/models/models_pe/entity_key.py +156 -0
- tb_rest_client/models/models_pe/entity_list_filter.py +162 -0
- tb_rest_client/models/models_pe/entity_load_error.py +202 -0
- tb_rest_client/models/models_pe/entity_name_filter.py +162 -0
- tb_rest_client/models/models_pe/entity_relation_info.py +320 -0
- tb_rest_client/models/models_pe/entity_relations_query.py +152 -0
- tb_rest_client/models/models_pe/entity_subtype.py +182 -0
- tb_rest_client/models/models_pe/entity_type_filter.py +136 -0
- tb_rest_client/models/models_pe/entity_type_load_result.py +286 -0
- tb_rest_client/models/models_pe/entity_type_version_create_config.py +312 -0
- tb_rest_client/models/models_pe/entity_type_version_load_config.py +306 -0
- tb_rest_client/models/models_pe/entity_type_version_load_request.py +156 -0
- tb_rest_client/models/models_pe/entity_version.py +202 -0
- tb_rest_client/models/models_pe/entity_view.py +449 -0
- tb_rest_client/models/models_pe/entity_view_id.py +162 -0
- tb_rest_client/models/models_pe/entity_view_info.py +505 -0
- tb_rest_client/models/models_pe/entity_view_search_query.py +180 -0
- tb_rest_client/models/models_pe/entity_view_search_query_filter.py +266 -0
- tb_rest_client/models/models_pe/entity_view_type_filter.py +182 -0
- tb_rest_client/models/models_pe/error_event_filter.py +188 -0
- tb_rest_client/models/models_pe/escalated_notification_rule_recipients_config.py +131 -0
- tb_rest_client/models/models_pe/event_filter.py +174 -0
- tb_rest_client/models/models_pe/event_id.py +127 -0
- tb_rest_client/models/models_pe/event_info.py +286 -0
- tb_rest_client/models/models_pe/exportable_entity_entity_id.py +150 -0
- tb_rest_client/models/models_pe/favicon.py +124 -0
- tb_rest_client/models/models_pe/features_info.py +254 -0
- tb_rest_client/models/models_pe/group_entity_export_data.py +130 -0
- tb_rest_client/models/models_pe/group_permission.py +370 -0
- tb_rest_client/models/models_pe/group_permission_id.py +162 -0
- tb_rest_client/models/models_pe/group_permission_info.py +560 -0
- tb_rest_client/models/models_pe/home_dashboard.py +478 -0
- tb_rest_client/models/models_pe/home_menu_item.py +320 -0
- tb_rest_client/models/models_pe/input_stream.py +98 -0
- tb_rest_client/models/models_pe/integration.py +571 -0
- tb_rest_client/models/models_pe/integration_converters_info.py +136 -0
- tb_rest_client/models/models_pe/integration_id.py +162 -0
- tb_rest_client/models/models_pe/integration_info.py +460 -0
- tb_rest_client/models/models_pe/integration_lifecycle_event_notification_rule_trigger_config.py +222 -0
- tb_rest_client/models/models_pe/json_node.py +98 -0
- tb_rest_client/models/models_pe/json_transport_payload_configuration.py +104 -0
- tb_rest_client/models/models_pe/key_filter.py +182 -0
- tb_rest_client/models/models_pe/key_filter_predicate.py +136 -0
- tb_rest_client/models/models_pe/last_visited_dashboard_info.py +210 -0
- tb_rest_client/models/models_pe/license_usage_info.py +332 -0
- tb_rest_client/models/models_pe/life_cycle_event_filter.py +222 -0
- tb_rest_client/models/models_pe/locale_code_upload_body.py +125 -0
- tb_rest_client/models/models_pe/login_request.py +156 -0
- tb_rest_client/models/models_pe/login_response.py +156 -0
- tb_rest_client/models/models_pe/login_white_labeling_params.py +682 -0
- tb_rest_client/models/models_pe/lw_m2_m_bootstrap_server_credential.py +136 -0
- tb_rest_client/models/models_pe/lw_m2_m_server_security_config_default.py +490 -0
- tb_rest_client/models/models_pe/lw_m2m_instance.py +154 -0
- tb_rest_client/models/models_pe/lw_m2m_object.py +266 -0
- tb_rest_client/models/models_pe/lw_m2m_resource_observe.py +266 -0
- tb_rest_client/models/models_pe/lwm2m_device_profile_transport_configuration.py +208 -0
- tb_rest_client/models/models_pe/lwm2m_device_transport_configuration.py +214 -0
- tb_rest_client/models/models_pe/mapping.py +202 -0
- tb_rest_client/models/models_pe/menu_item.py +152 -0
- tb_rest_client/models/models_pe/merged_group_permission_info.py +163 -0
- tb_rest_client/models/models_pe/merged_group_type_permission_info.py +154 -0
- tb_rest_client/models/models_pe/merged_user_permissions.py +273 -0
- tb_rest_client/models/models_pe/mobile_app_delivery_method_notification_template.py +157 -0
- tb_rest_client/models/models_pe/mobile_app_notification_delivery_method_config.py +182 -0
- tb_rest_client/models/models_pe/mobile_app_settings_id.py +113 -0
- tb_rest_client/models/models_pe/mobile_redirect_params.py +154 -0
- tb_rest_client/models/models_pe/mobile_self_registration_params.py +98 -0
- tb_rest_client/models/models_pe/mobile_session_info.py +124 -0
- tb_rest_client/models/models_pe/model.py +162 -0
- tb_rest_client/models/models_pe/mqtt_device_profile_transport_configuration.py +286 -0
- tb_rest_client/models/models_pe/mqtt_device_transport_configuration.py +104 -0
- tb_rest_client/models/models_pe/new_platform_version_notification_rule_trigger_config.py +104 -0
- tb_rest_client/models/models_pe/no_sec_lw_m2_m_bootstrap_server_credential.py +440 -0
- tb_rest_client/models/models_pe/node_connection_info.py +185 -0
- tb_rest_client/models/models_pe/notification.py +402 -0
- tb_rest_client/models/models_pe/notification_delivery_method_config.py +134 -0
- tb_rest_client/models/models_pe/notification_id.py +162 -0
- tb_rest_client/models/models_pe/notification_info.py +185 -0
- tb_rest_client/models/models_pe/notification_request.py +417 -0
- tb_rest_client/models/models_pe/notification_request_config.py +124 -0
- tb_rest_client/models/models_pe/notification_request_id.py +162 -0
- tb_rest_client/models/models_pe/notification_request_preview.py +202 -0
- tb_rest_client/models/models_pe/notification_request_stats.py +202 -0
- tb_rest_client/models/models_pe/notification_rule_config.py +124 -0
- tb_rest_client/models/models_pe/notification_rule_id.py +162 -0
- tb_rest_client/models/models_pe/notification_rule_recipients_config.py +139 -0
- tb_rest_client/models/models_pe/notification_rule_trigger_config.py +135 -0
- tb_rest_client/models/models_pe/notification_template_config.py +125 -0
- tb_rest_client/models/models_pe/notification_template_id.py +162 -0
- tb_rest_client/models/models_pe/numeric_filter_predicate.py +162 -0
- tb_rest_client/models/models_pe/o_auth2_basic_mapper_config.py +381 -0
- tb_rest_client/models/models_pe/o_auth2_client_info.py +267 -0
- tb_rest_client/models/models_pe/o_auth2_client_registration_template.py +565 -0
- tb_rest_client/models/models_pe/o_auth2_client_registration_template_id.py +127 -0
- tb_rest_client/models/models_pe/o_auth2_custom_mapper_config.py +202 -0
- tb_rest_client/models/models_pe/o_auth2_domain_info.py +162 -0
- tb_rest_client/models/models_pe/o_auth2_info.py +183 -0
- tb_rest_client/models/models_pe/o_auth2_mapper_config.py +241 -0
- tb_rest_client/models/models_pe/o_auth2_mobile_info.py +156 -0
- tb_rest_client/models/models_pe/o_auth2_params_info.py +185 -0
- tb_rest_client/models/models_pe/o_auth2_registration_info.py +502 -0
- tb_rest_client/models/models_pe/object_attributes.py +410 -0
- tb_rest_client/models/models_pe/object_node.py +98 -0
- tb_rest_client/models/models_pe/originator_entity_owner_users_filter.py +104 -0
- tb_rest_client/models/models_pe/ota_package.py +576 -0
- tb_rest_client/models/models_pe/ota_package_id.py +162 -0
- tb_rest_client/models/models_pe/ota_package_info.py +550 -0
- tb_rest_client/models/models_pe/ota_package_ota_package_id_body.py +184 -0
- tb_rest_client/models/models_pe/other_configuration.py +364 -0
- tb_rest_client/models/models_pe/page_data_blob_entity_with_customer_info.py +210 -0
- tb_rest_client/models/models_pe/page_data_contact_basedobject.py +210 -0
- tb_rest_client/models/models_pe/page_data_converter.py +210 -0
- tb_rest_client/models/models_pe/page_data_customer_info.py +210 -0
- tb_rest_client/models/models_pe/page_data_edge.py +210 -0
- tb_rest_client/models/models_pe/page_data_edge_event.py +210 -0
- tb_rest_client/models/models_pe/page_data_edge_info.py +210 -0
- tb_rest_client/models/models_pe/page_data_entity_group_info.py +210 -0
- tb_rest_client/models/models_pe/page_data_entity_version.py +210 -0
- tb_rest_client/models/models_pe/page_data_entity_view_info.py +210 -0
- tb_rest_client/models/models_pe/page_data_event_info.py +210 -0
- tb_rest_client/models/models_pe/page_data_integration.py +210 -0
- tb_rest_client/models/models_pe/page_data_integration_info.py +210 -0
- tb_rest_client/models/models_pe/page_data_ota_package_info.py +210 -0
- tb_rest_client/models/models_pe/page_data_queue.py +210 -0
- tb_rest_client/models/models_pe/page_data_role.py +210 -0
- tb_rest_client/models/models_pe/page_data_rule_chain.py +210 -0
- tb_rest_client/models/models_pe/page_data_scheduler_event_info.py +210 -0
- tb_rest_client/models/models_pe/page_data_short_entity_view.py +210 -0
- tb_rest_client/models/models_pe/page_data_user_email_info.py +210 -0
- tb_rest_client/models/models_pe/page_data_user_info.py +210 -0
- tb_rest_client/models/models_pe/palette.py +183 -0
- tb_rest_client/models/models_pe/palette_settings.py +152 -0
- tb_rest_client/models/models_pe/platform_two_fa_settings.py +257 -0
- tb_rest_client/models/models_pe/platform_users_notification_target_config.py +131 -0
- tb_rest_client/models/models_pe/power_saving_configuration.py +208 -0
- tb_rest_client/models/models_pe/processing_strategy.py +234 -0
- tb_rest_client/models/models_pe/proto_transport_payload_configuration.py +260 -0
- tb_rest_client/models/models_pe/psklw_m2_m_bootstrap_server_credential.py +440 -0
- tb_rest_client/models/models_pe/queue.py +410 -0
- tb_rest_client/models/models_pe/raw_data_event_filter.py +216 -0
- tb_rest_client/models/models_pe/relation_entity_type_filter.py +189 -0
- tb_rest_client/models/models_pe/relations_query_filter.py +350 -0
- tb_rest_client/models/models_pe/relations_search_parameters.py +284 -0
- tb_rest_client/models/models_pe/repeating_alarm_condition_spec.py +130 -0
- tb_rest_client/models/models_pe/report_config.py +381 -0
- tb_rest_client/models/models_pe/repository_settings.py +390 -0
- tb_rest_client/models/models_pe/repository_settings_info.py +150 -0
- tb_rest_client/models/models_pe/reset_password_email_request.py +126 -0
- tb_rest_client/models/models_pe/reset_password_request.py +154 -0
- tb_rest_client/models/models_pe/resource.py +306 -0
- tb_rest_client/models/models_pe/response_entity.py +182 -0
- tb_rest_client/models/models_pe/role.py +371 -0
- tb_rest_client/models/models_pe/role_id.py +162 -0
- tb_rest_client/models/models_pe/rpc.py +344 -0
- tb_rest_client/models/models_pe/rpc_id.py +162 -0
- tb_rest_client/models/models_pe/rpklw_m2_m_bootstrap_server_credential.py +440 -0
- tb_rest_client/models/models_pe/rule_chain.py +402 -0
- tb_rest_client/models/models_pe/rule_chain_connection_info.py +210 -0
- tb_rest_client/models/models_pe/rule_chain_data.py +156 -0
- tb_rest_client/models/models_pe/rule_chain_debug_event_filter.py +240 -0
- tb_rest_client/models/models_pe/rule_chain_export_data.py +156 -0
- tb_rest_client/models/models_pe/rule_chain_id.py +162 -0
- tb_rest_client/models/models_pe/rule_chain_import_result.py +202 -0
- tb_rest_client/models/models_pe/rule_chain_meta_data.py +269 -0
- tb_rest_client/models/models_pe/rule_chain_output_labels_usage.py +239 -0
- tb_rest_client/models/models_pe/rule_engine_component_lifecycle_event_notification_rule_trigger_config.py +274 -0
- tb_rest_client/models/models_pe/rule_node.py +424 -0
- tb_rest_client/models/models_pe/rule_node_debug_event_filter.py +448 -0
- tb_rest_client/models/models_pe/rule_node_id.py +162 -0
- tb_rest_client/models/models_pe/save_device_with_credentials_request.py +152 -0
- tb_rest_client/models/models_pe/save_ota_package_info_request.py +578 -0
- tb_rest_client/models/models_pe/scheduler_event.py +444 -0
- tb_rest_client/models/models_pe/scheduler_event_filter.py +156 -0
- tb_rest_client/models/models_pe/scheduler_event_id.py +162 -0
- tb_rest_client/models/models_pe/scheduler_event_info.py +418 -0
- tb_rest_client/models/models_pe/scheduler_event_with_customer_info.py +474 -0
- tb_rest_client/models/models_pe/security_settings.py +266 -0
- tb_rest_client/models/models_pe/self_registration_params.py +630 -0
- tb_rest_client/models/models_pe/share_group_request.py +235 -0
- tb_rest_client/models/models_pe/shared_attributes_setting_snmp_communication_config.py +130 -0
- tb_rest_client/models/models_pe/short_customer_info.py +204 -0
- tb_rest_client/models/models_pe/short_entity_view.py +154 -0
- tb_rest_client/models/models_pe/sign_up_field.py +184 -0
- tb_rest_client/models/models_pe/sign_up_request.py +294 -0
- tb_rest_client/models/models_pe/sign_up_self_registration_params.py +266 -0
- tb_rest_client/models/models_pe/simple_alarm_condition_spec.py +104 -0
- tb_rest_client/models/models_pe/single_entity_filter.py +130 -0
- tb_rest_client/models/models_pe/single_entity_version_create_request.py +156 -0
- tb_rest_client/models/models_pe/single_entity_version_load_request.py +182 -0
- tb_rest_client/models/models_pe/slack_conversation.py +263 -0
- tb_rest_client/models/models_pe/slack_delivery_method_notification_template.py +104 -0
- tb_rest_client/models/models_pe/slack_notification_delivery_method_config.py +131 -0
- tb_rest_client/models/models_pe/slack_notification_target_config.py +163 -0
- tb_rest_client/models/models_pe/smpp_sms_provider_configuration.py +541 -0
- tb_rest_client/models/models_pe/sms_delivery_method_notification_template.py +104 -0
- tb_rest_client/models/models_pe/sms_provider_configuration.py +135 -0
- tb_rest_client/models/models_pe/sms_two_fa_account_config.py +131 -0
- tb_rest_client/models/models_pe/sms_two_fa_provider_config.py +157 -0
- tb_rest_client/models/models_pe/snmp_communication_config.py +142 -0
- tb_rest_client/models/models_pe/snmp_device_profile_transport_configuration.py +182 -0
- tb_rest_client/models/models_pe/snmp_device_transport_configuration.py +434 -0
- tb_rest_client/models/models_pe/snmp_mapping.py +182 -0
- tb_rest_client/models/models_pe/solution_install_response.py +260 -0
- tb_rest_client/models/models_pe/specific_time_schedule.py +208 -0
- tb_rest_client/models/models_pe/starred_dashboard_info.py +182 -0
- tb_rest_client/models/models_pe/state_entity_owner_filter.py +130 -0
- tb_rest_client/models/models_pe/statistics_event_filter.py +244 -0
- tb_rest_client/models/models_pe/string_filter_predicate.py +188 -0
- tb_rest_client/models/models_pe/submit_strategy.py +156 -0
- tb_rest_client/models/models_pe/subscription_usage.py +540 -0
- tb_rest_client/models/models_pe/system_administrators_filter.py +104 -0
- tb_rest_client/models/models_pe/system_info.py +152 -0
- tb_rest_client/models/models_pe/system_info_data.py +322 -0
- tb_rest_client/models/models_pe/task_processing_failure_notification_rule_trigger_config.py +98 -0
- tb_rest_client/models/models_pe/tb_image_delete_result.py +176 -0
- tb_rest_client/models/models_pe/tb_resource.py +594 -0
- tb_rest_client/models/models_pe/tb_resource_id.py +162 -0
- tb_rest_client/models/models_pe/tb_resource_info.py +540 -0
- tb_rest_client/models/models_pe/telemetry_entity_view.py +154 -0
- tb_rest_client/models/models_pe/telemetry_mapping_configuration.py +228 -0
- tb_rest_client/models/models_pe/telemetry_querying_snmp_communication_config.py +156 -0
- tb_rest_client/models/models_pe/tenant_administrators_filter.py +156 -0
- tb_rest_client/models/models_pe/tenant_profile_configuration.py +133 -0
- tb_rest_client/models/models_pe/tenant_profile_data.py +154 -0
- tb_rest_client/models/models_pe/tenant_profile_id.py +162 -0
- tb_rest_client/models/models_pe/tenant_profile_queue_configuration.py +332 -0
- tb_rest_client/models/models_pe/tenant_solution_template_details.py +376 -0
- tb_rest_client/models/models_pe/tenant_solution_template_info.py +440 -0
- tb_rest_client/models/models_pe/tenant_solution_template_instructions.py +232 -0
- tb_rest_client/models/models_pe/test_sms_request.py +182 -0
- tb_rest_client/models/models_pe/thingsboard_credentials_expired_response.py +238 -0
- tb_rest_client/models/models_pe/thingsboard_error_response.py +210 -0
- tb_rest_client/models/models_pe/to_device_rpc_request_snmp_communication_config.py +130 -0
- tb_rest_client/models/models_pe/totp_two_fa_account_config.py +131 -0
- tb_rest_client/models/models_pe/totp_two_fa_provider_config.py +131 -0
- tb_rest_client/models/models_pe/translation_info.py +238 -0
- tb_rest_client/models/models_pe/transport_payload_type_configuration.py +134 -0
- tb_rest_client/models/models_pe/ts_value.py +176 -0
- tb_rest_client/models/models_pe/twilio_sms_provider_configuration.py +188 -0
- tb_rest_client/models/models_pe/two_fa_account_config.py +162 -0
- tb_rest_client/models/models_pe/two_fa_account_config_update_request.py +124 -0
- tb_rest_client/models/models_pe/two_fa_provider_config.py +136 -0
- tb_rest_client/models/models_pe/two_fa_provider_info.py +234 -0
- tb_rest_client/models/models_pe/update_message.py +266 -0
- tb_rest_client/models/models_pe/user.py +484 -0
- tb_rest_client/models/models_pe/user_dashboards_info.py +154 -0
- tb_rest_client/models/models_pe/user_email_info.py +208 -0
- tb_rest_client/models/models_pe/user_group_list_filter.py +131 -0
- tb_rest_client/models/models_pe/user_id.py +162 -0
- tb_rest_client/models/models_pe/user_info.py +540 -0
- tb_rest_client/models/models_pe/user_list_filter.py +131 -0
- tb_rest_client/models/models_pe/user_password_policy.py +378 -0
- tb_rest_client/models/models_pe/user_role_filter.py +131 -0
- tb_rest_client/models/models_pe/users_filter.py +142 -0
- tb_rest_client/models/models_pe/v2_captcha_params.py +98 -0
- tb_rest_client/models/models_pe/v3_captcha_params.py +98 -0
- tb_rest_client/models/models_pe/vendor.py +150 -0
- tb_rest_client/models/models_pe/version_create_config.py +228 -0
- tb_rest_client/models/models_pe/version_create_request.py +191 -0
- tb_rest_client/models/models_pe/version_creation_result.py +254 -0
- tb_rest_client/models/models_pe/version_load_config.py +254 -0
- tb_rest_client/models/models_pe/version_load_request.py +165 -0
- tb_rest_client/models/models_pe/version_load_result.py +176 -0
- tb_rest_client/models/models_pe/versioned_entity_info.py +150 -0
- tb_rest_client/models/models_pe/web_delivery_method_notification_template.py +157 -0
- tb_rest_client/models/models_pe/web_self_registration_params.py +98 -0
- tb_rest_client/models/models_pe/white_labeling.py +234 -0
- tb_rest_client/models/models_pe/white_labeling_params.py +486 -0
- tb_rest_client/models/models_pe/widget_type.py +342 -0
- tb_rest_client/models/models_pe/widget_type_details.py +426 -0
- tb_rest_client/models/models_pe/widget_type_export_data.py +130 -0
- tb_rest_client/models/models_pe/widget_type_id.py +162 -0
- tb_rest_client/models/models_pe/widget_type_info.py +428 -0
- tb_rest_client/models/models_pe/widgets_bundle_export_data.py +182 -0
- tb_rest_client/models/models_pe/widgets_bundle_id.py +162 -0
- tb_rest_client/models/models_pe/x509_certificate_chain_provision_configuration.py +156 -0
- tb_rest_client/models/models_pe/x509_lw_m2_m_bootstrap_server_credential.py +440 -0
- tb_rest_client/rest.py +342 -0
- tb_rest_client/rest_client_base.py +2193 -0
- tb_rest_client/rest_client_ce.py +1284 -0
- tb_rest_client/rest_client_pe.py +1910 -0
- tb_rest_client-3.9.0.dist-info/LICENSE +201 -0
- tb_rest_client-3.9.0.dist-info/METADATA +80 -0
- tb_rest_client-3.9.0.dist-info/RECORD +1111 -0
- tb_rest_client-3.9.0.dist-info/WHEEL +4 -0
|
@@ -0,0 +1,3936 @@
|
|
|
1
|
+
# coding: utf-8
|
|
2
|
+
|
|
3
|
+
"""
|
|
4
|
+
ThingsBoard REST API
|
|
5
|
+
|
|
6
|
+
ThingsBoard Professional Edition IoT platform REST API documentation. # noqa: E501
|
|
7
|
+
|
|
8
|
+
OpenAPI spec version: 3.9.0PE
|
|
9
|
+
Contact: info@thingsboard.io
|
|
10
|
+
Generated by: https://github.com/swagger-api/swagger-codegen.git
|
|
11
|
+
"""
|
|
12
|
+
|
|
13
|
+
# Copyright 2025. ThingsBoard
|
|
14
|
+
#
|
|
15
|
+
# Licensed under the Apache License, Version 2.0 (the "License");
|
|
16
|
+
# you may not use this file except in compliance with the License.
|
|
17
|
+
# You may obtain a copy of the License at
|
|
18
|
+
#
|
|
19
|
+
# http://www.apache.org/licenses/LICENSE-2.0
|
|
20
|
+
#
|
|
21
|
+
# Unless required by applicable law or agreed to in writing, software
|
|
22
|
+
# distributed under the License is distributed on an "AS IS" BASIS,
|
|
23
|
+
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
24
|
+
# See the License for the specific language governing permissions and
|
|
25
|
+
# limitations under the License.
|
|
26
|
+
|
|
27
|
+
from __future__ import absolute_import
|
|
28
|
+
|
|
29
|
+
import re # noqa: F401
|
|
30
|
+
|
|
31
|
+
# python 2 and python 3 compatibility library
|
|
32
|
+
import six
|
|
33
|
+
|
|
34
|
+
from tb_rest_client.api_client import ApiClient
|
|
35
|
+
|
|
36
|
+
|
|
37
|
+
class EntityGroupControllerApi(object):
|
|
38
|
+
"""NOTE: This class is auto generated by the swagger code generator program.
|
|
39
|
+
|
|
40
|
+
Do not edit the class manually.
|
|
41
|
+
Ref: https://github.com/swagger-api/swagger-codegen
|
|
42
|
+
"""
|
|
43
|
+
|
|
44
|
+
def __init__(self, api_client=None):
|
|
45
|
+
if api_client is None:
|
|
46
|
+
api_client = ApiClient()
|
|
47
|
+
self.api_client = api_client
|
|
48
|
+
|
|
49
|
+
def add_entities_to_entity_group_using_post(self, entity_group_id, **kwargs): # noqa: E501
|
|
50
|
+
"""Add entities to the group (addEntitiesToEntityGroup) # noqa: E501
|
|
51
|
+
|
|
52
|
+
Add entities to the specified entity group. Entity group allows you to group multiple entities of the same entity type (Device, Asset, Customer, User, Dashboard, etc). Entity Group always have an owner - particular Tenant or Customer. Each entity may belong to multiple groups simultaneously. Available for users with 'TENANT_ADMIN' or 'CUSTOMER_USER' authority. Security check is performed to verify that the user has 'ADD_TO_GROUP' permission for specified group. # noqa: E501
|
|
53
|
+
This method makes a synchronous HTTP request by default. To make an
|
|
54
|
+
asynchronous HTTP request, please pass async_req=True
|
|
55
|
+
>>> thread = api.add_entities_to_entity_group_using_post(entity_group_id, async_req=True)
|
|
56
|
+
>>> result = thread.get()
|
|
57
|
+
|
|
58
|
+
:param async_req bool
|
|
59
|
+
:param str entity_group_id: A string value representing the Entity Group Id. For example, '784f394c-42b6-435a-983c-b7beff2784f9' (required)
|
|
60
|
+
:param list[str] body:
|
|
61
|
+
:return: None
|
|
62
|
+
If the method is called asynchronously,
|
|
63
|
+
returns the request thread.
|
|
64
|
+
"""
|
|
65
|
+
kwargs['_return_http_data_only'] = True
|
|
66
|
+
if kwargs.get('async_req'):
|
|
67
|
+
return self.add_entities_to_entity_group_using_post_with_http_info(entity_group_id, **kwargs) # noqa: E501
|
|
68
|
+
else:
|
|
69
|
+
(data) = self.add_entities_to_entity_group_using_post_with_http_info(entity_group_id, **kwargs) # noqa: E501
|
|
70
|
+
return data
|
|
71
|
+
|
|
72
|
+
def add_entities_to_entity_group_using_post_with_http_info(self, entity_group_id, **kwargs): # noqa: E501
|
|
73
|
+
"""Add entities to the group (addEntitiesToEntityGroup) # noqa: E501
|
|
74
|
+
|
|
75
|
+
Add entities to the specified entity group. Entity group allows you to group multiple entities of the same entity type (Device, Asset, Customer, User, Dashboard, etc). Entity Group always have an owner - particular Tenant or Customer. Each entity may belong to multiple groups simultaneously. Available for users with 'TENANT_ADMIN' or 'CUSTOMER_USER' authority. Security check is performed to verify that the user has 'ADD_TO_GROUP' permission for specified group. # noqa: E501
|
|
76
|
+
This method makes a synchronous HTTP request by default. To make an
|
|
77
|
+
asynchronous HTTP request, please pass async_req=True
|
|
78
|
+
>>> thread = api.add_entities_to_entity_group_using_post_with_http_info(entity_group_id, async_req=True)
|
|
79
|
+
>>> result = thread.get()
|
|
80
|
+
|
|
81
|
+
:param async_req bool
|
|
82
|
+
:param str entity_group_id: A string value representing the Entity Group Id. For example, '784f394c-42b6-435a-983c-b7beff2784f9' (required)
|
|
83
|
+
:param list[str] body:
|
|
84
|
+
:return: None
|
|
85
|
+
If the method is called asynchronously,
|
|
86
|
+
returns the request thread.
|
|
87
|
+
"""
|
|
88
|
+
|
|
89
|
+
all_params = ['entity_group_id', 'body'] # noqa: E501
|
|
90
|
+
all_params.append('async_req')
|
|
91
|
+
all_params.append('_return_http_data_only')
|
|
92
|
+
all_params.append('_preload_content')
|
|
93
|
+
all_params.append('_request_timeout')
|
|
94
|
+
|
|
95
|
+
params = locals()
|
|
96
|
+
for key, val in six.iteritems(params['kwargs']):
|
|
97
|
+
if key not in all_params:
|
|
98
|
+
raise TypeError(
|
|
99
|
+
"Got an unexpected keyword argument '%s'"
|
|
100
|
+
" to method add_entities_to_entity_group_using_post" % key
|
|
101
|
+
)
|
|
102
|
+
params[key] = val
|
|
103
|
+
del params['kwargs']
|
|
104
|
+
# verify the required parameter 'entity_group_id' is set
|
|
105
|
+
if ('entity_group_id' not in params or
|
|
106
|
+
params['entity_group_id'] is None):
|
|
107
|
+
raise ValueError("Missing the required parameter `entity_group_id` when calling `add_entities_to_entity_group_using_post`") # noqa: E501
|
|
108
|
+
|
|
109
|
+
collection_formats = {}
|
|
110
|
+
|
|
111
|
+
path_params = {}
|
|
112
|
+
if 'entity_group_id' in params:
|
|
113
|
+
path_params['entityGroupId'] = params['entity_group_id'] # noqa: E501
|
|
114
|
+
|
|
115
|
+
query_params = []
|
|
116
|
+
|
|
117
|
+
header_params = {}
|
|
118
|
+
|
|
119
|
+
form_params = []
|
|
120
|
+
local_var_files = {}
|
|
121
|
+
|
|
122
|
+
body_params = None
|
|
123
|
+
if 'body' in params:
|
|
124
|
+
body_params = params['body']
|
|
125
|
+
# HTTP header `Accept`
|
|
126
|
+
header_params['Accept'] = self.api_client.select_header_accept(
|
|
127
|
+
['application/json']) # noqa: E501
|
|
128
|
+
|
|
129
|
+
# HTTP header `Content-Type`
|
|
130
|
+
header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501
|
|
131
|
+
['application/json']) # noqa: E501
|
|
132
|
+
|
|
133
|
+
# Authentication setting
|
|
134
|
+
auth_settings = ['X-Authorization'] # noqa: E501
|
|
135
|
+
|
|
136
|
+
return self.api_client.call_api(
|
|
137
|
+
'/api/entityGroup/{entityGroupId}/addEntities', 'POST',
|
|
138
|
+
path_params,
|
|
139
|
+
query_params,
|
|
140
|
+
header_params,
|
|
141
|
+
body=body_params,
|
|
142
|
+
post_params=form_params,
|
|
143
|
+
files=local_var_files,
|
|
144
|
+
response_type=None, # noqa: E501
|
|
145
|
+
auth_settings=auth_settings,
|
|
146
|
+
async_req=params.get('async_req'),
|
|
147
|
+
_return_http_data_only=params.get('_return_http_data_only'),
|
|
148
|
+
_preload_content=params.get('_preload_content', True),
|
|
149
|
+
_request_timeout=params.get('_request_timeout'),
|
|
150
|
+
collection_formats=collection_formats)
|
|
151
|
+
|
|
152
|
+
def assign_entity_group_to_edge_using_post(self, edge_id, group_type, entity_group_id, **kwargs): # noqa: E501
|
|
153
|
+
"""Assign entity group to edge (assignEntityGroupToEdge) # noqa: E501
|
|
154
|
+
|
|
155
|
+
Creates assignment of an existing entity group to an instance of The Edge. Assignment works in async way - first, notification event pushed to edge service queue on platform. Second, remote edge service will receive a copy of assignment entity group (Edge will receive this instantly, if it's currently connected, or once it's going to be connected to platform). Third, once entity group will be delivered to edge service, edge will request entities of this group to be send to edge. Once entities will be delivered to edge service, they are going to be available for usage on remote edge instance. Available for users with 'TENANT_ADMIN' or 'CUSTOMER_USER' authority. Security check is performed to verify that the user has 'WRITE' permission for the entity (entities). # noqa: E501
|
|
156
|
+
This method makes a synchronous HTTP request by default. To make an
|
|
157
|
+
asynchronous HTTP request, please pass async_req=True
|
|
158
|
+
>>> thread = api.assign_entity_group_to_edge_using_post(edge_id, group_type, entity_group_id, async_req=True)
|
|
159
|
+
>>> result = thread.get()
|
|
160
|
+
|
|
161
|
+
:param async_req bool
|
|
162
|
+
:param str edge_id: A string value representing the edge id. For example, '784f394c-42b6-435a-983c-b7beff2784f9' (required)
|
|
163
|
+
:param str group_type: EntityGroup type (required)
|
|
164
|
+
:param str entity_group_id: A string value representing the Entity Group Id. For example, '784f394c-42b6-435a-983c-b7beff2784f9' (required)
|
|
165
|
+
:return: EntityGroup
|
|
166
|
+
If the method is called asynchronously,
|
|
167
|
+
returns the request thread.
|
|
168
|
+
"""
|
|
169
|
+
kwargs['_return_http_data_only'] = True
|
|
170
|
+
if kwargs.get('async_req'):
|
|
171
|
+
return self.assign_entity_group_to_edge_using_post_with_http_info(edge_id, group_type, entity_group_id, **kwargs) # noqa: E501
|
|
172
|
+
else:
|
|
173
|
+
(data) = self.assign_entity_group_to_edge_using_post_with_http_info(edge_id, group_type, entity_group_id, **kwargs) # noqa: E501
|
|
174
|
+
return data
|
|
175
|
+
|
|
176
|
+
def assign_entity_group_to_edge_using_post_with_http_info(self, edge_id, group_type, entity_group_id, **kwargs): # noqa: E501
|
|
177
|
+
"""Assign entity group to edge (assignEntityGroupToEdge) # noqa: E501
|
|
178
|
+
|
|
179
|
+
Creates assignment of an existing entity group to an instance of The Edge. Assignment works in async way - first, notification event pushed to edge service queue on platform. Second, remote edge service will receive a copy of assignment entity group (Edge will receive this instantly, if it's currently connected, or once it's going to be connected to platform). Third, once entity group will be delivered to edge service, edge will request entities of this group to be send to edge. Once entities will be delivered to edge service, they are going to be available for usage on remote edge instance. Available for users with 'TENANT_ADMIN' or 'CUSTOMER_USER' authority. Security check is performed to verify that the user has 'WRITE' permission for the entity (entities). # noqa: E501
|
|
180
|
+
This method makes a synchronous HTTP request by default. To make an
|
|
181
|
+
asynchronous HTTP request, please pass async_req=True
|
|
182
|
+
>>> thread = api.assign_entity_group_to_edge_using_post_with_http_info(edge_id, group_type, entity_group_id, async_req=True)
|
|
183
|
+
>>> result = thread.get()
|
|
184
|
+
|
|
185
|
+
:param async_req bool
|
|
186
|
+
:param str edge_id: A string value representing the edge id. For example, '784f394c-42b6-435a-983c-b7beff2784f9' (required)
|
|
187
|
+
:param str group_type: EntityGroup type (required)
|
|
188
|
+
:param str entity_group_id: A string value representing the Entity Group Id. For example, '784f394c-42b6-435a-983c-b7beff2784f9' (required)
|
|
189
|
+
:return: EntityGroup
|
|
190
|
+
If the method is called asynchronously,
|
|
191
|
+
returns the request thread.
|
|
192
|
+
"""
|
|
193
|
+
|
|
194
|
+
all_params = ['edge_id', 'group_type', 'entity_group_id'] # noqa: E501
|
|
195
|
+
all_params.append('async_req')
|
|
196
|
+
all_params.append('_return_http_data_only')
|
|
197
|
+
all_params.append('_preload_content')
|
|
198
|
+
all_params.append('_request_timeout')
|
|
199
|
+
|
|
200
|
+
params = locals()
|
|
201
|
+
for key, val in six.iteritems(params['kwargs']):
|
|
202
|
+
if key not in all_params:
|
|
203
|
+
raise TypeError(
|
|
204
|
+
"Got an unexpected keyword argument '%s'"
|
|
205
|
+
" to method assign_entity_group_to_edge_using_post" % key
|
|
206
|
+
)
|
|
207
|
+
params[key] = val
|
|
208
|
+
del params['kwargs']
|
|
209
|
+
# verify the required parameter 'edge_id' is set
|
|
210
|
+
if ('edge_id' not in params or
|
|
211
|
+
params['edge_id'] is None):
|
|
212
|
+
raise ValueError("Missing the required parameter `edge_id` when calling `assign_entity_group_to_edge_using_post`") # noqa: E501
|
|
213
|
+
# verify the required parameter 'group_type' is set
|
|
214
|
+
if ('group_type' not in params or
|
|
215
|
+
params['group_type'] is None):
|
|
216
|
+
raise ValueError("Missing the required parameter `group_type` when calling `assign_entity_group_to_edge_using_post`") # noqa: E501
|
|
217
|
+
# verify the required parameter 'entity_group_id' is set
|
|
218
|
+
if ('entity_group_id' not in params or
|
|
219
|
+
params['entity_group_id'] is None):
|
|
220
|
+
raise ValueError("Missing the required parameter `entity_group_id` when calling `assign_entity_group_to_edge_using_post`") # noqa: E501
|
|
221
|
+
|
|
222
|
+
collection_formats = {}
|
|
223
|
+
|
|
224
|
+
path_params = {}
|
|
225
|
+
if 'edge_id' in params:
|
|
226
|
+
path_params['edgeId'] = params['edge_id'] # noqa: E501
|
|
227
|
+
if 'group_type' in params:
|
|
228
|
+
path_params['groupType'] = params['group_type'] # noqa: E501
|
|
229
|
+
if 'entity_group_id' in params:
|
|
230
|
+
path_params['entityGroupId'] = params['entity_group_id'] # noqa: E501
|
|
231
|
+
|
|
232
|
+
query_params = []
|
|
233
|
+
|
|
234
|
+
header_params = {}
|
|
235
|
+
|
|
236
|
+
form_params = []
|
|
237
|
+
local_var_files = {}
|
|
238
|
+
|
|
239
|
+
body_params = None
|
|
240
|
+
# HTTP header `Accept`
|
|
241
|
+
header_params['Accept'] = self.api_client.select_header_accept(
|
|
242
|
+
['application/json']) # noqa: E501
|
|
243
|
+
|
|
244
|
+
# Authentication setting
|
|
245
|
+
auth_settings = ['X-Authorization'] # noqa: E501
|
|
246
|
+
|
|
247
|
+
return self.api_client.call_api(
|
|
248
|
+
'/api/edge/{edgeId}/entityGroup/{entityGroupId}/{groupType}', 'POST',
|
|
249
|
+
path_params,
|
|
250
|
+
query_params,
|
|
251
|
+
header_params,
|
|
252
|
+
body=body_params,
|
|
253
|
+
post_params=form_params,
|
|
254
|
+
files=local_var_files,
|
|
255
|
+
response_type='EntityGroup', # noqa: E501
|
|
256
|
+
auth_settings=auth_settings,
|
|
257
|
+
async_req=params.get('async_req'),
|
|
258
|
+
_return_http_data_only=params.get('_return_http_data_only'),
|
|
259
|
+
_preload_content=params.get('_preload_content', True),
|
|
260
|
+
_request_timeout=params.get('_request_timeout'),
|
|
261
|
+
collection_formats=collection_formats)
|
|
262
|
+
|
|
263
|
+
def delete_entity_group_using_delete(self, entity_group_id, **kwargs): # noqa: E501
|
|
264
|
+
"""Delete Entity Group (deleteEntityGroup) # noqa: E501
|
|
265
|
+
|
|
266
|
+
Deletes the entity group but does not delete the entities in the group, since they are also present in reserved group 'All'. Referencing non-existing Entity Group Id will cause an error. Available for users with 'TENANT_ADMIN' or 'CUSTOMER_USER' authority. Security check is performed to verify that the user has 'DELETE' permission for specified group. # noqa: E501
|
|
267
|
+
This method makes a synchronous HTTP request by default. To make an
|
|
268
|
+
asynchronous HTTP request, please pass async_req=True
|
|
269
|
+
>>> thread = api.delete_entity_group_using_delete(entity_group_id, async_req=True)
|
|
270
|
+
>>> result = thread.get()
|
|
271
|
+
|
|
272
|
+
:param async_req bool
|
|
273
|
+
:param str entity_group_id: A string value representing the Entity Group Id. For example, '784f394c-42b6-435a-983c-b7beff2784f9' (required)
|
|
274
|
+
:return: None
|
|
275
|
+
If the method is called asynchronously,
|
|
276
|
+
returns the request thread.
|
|
277
|
+
"""
|
|
278
|
+
kwargs['_return_http_data_only'] = True
|
|
279
|
+
if kwargs.get('async_req'):
|
|
280
|
+
return self.delete_entity_group_using_delete_with_http_info(entity_group_id, **kwargs) # noqa: E501
|
|
281
|
+
else:
|
|
282
|
+
(data) = self.delete_entity_group_using_delete_with_http_info(entity_group_id, **kwargs) # noqa: E501
|
|
283
|
+
return data
|
|
284
|
+
|
|
285
|
+
def delete_entity_group_using_delete_with_http_info(self, entity_group_id, **kwargs): # noqa: E501
|
|
286
|
+
"""Delete Entity Group (deleteEntityGroup) # noqa: E501
|
|
287
|
+
|
|
288
|
+
Deletes the entity group but does not delete the entities in the group, since they are also present in reserved group 'All'. Referencing non-existing Entity Group Id will cause an error. Available for users with 'TENANT_ADMIN' or 'CUSTOMER_USER' authority. Security check is performed to verify that the user has 'DELETE' permission for specified group. # noqa: E501
|
|
289
|
+
This method makes a synchronous HTTP request by default. To make an
|
|
290
|
+
asynchronous HTTP request, please pass async_req=True
|
|
291
|
+
>>> thread = api.delete_entity_group_using_delete_with_http_info(entity_group_id, async_req=True)
|
|
292
|
+
>>> result = thread.get()
|
|
293
|
+
|
|
294
|
+
:param async_req bool
|
|
295
|
+
:param str entity_group_id: A string value representing the Entity Group Id. For example, '784f394c-42b6-435a-983c-b7beff2784f9' (required)
|
|
296
|
+
:return: None
|
|
297
|
+
If the method is called asynchronously,
|
|
298
|
+
returns the request thread.
|
|
299
|
+
"""
|
|
300
|
+
|
|
301
|
+
all_params = ['entity_group_id'] # noqa: E501
|
|
302
|
+
all_params.append('async_req')
|
|
303
|
+
all_params.append('_return_http_data_only')
|
|
304
|
+
all_params.append('_preload_content')
|
|
305
|
+
all_params.append('_request_timeout')
|
|
306
|
+
|
|
307
|
+
params = locals()
|
|
308
|
+
for key, val in six.iteritems(params['kwargs']):
|
|
309
|
+
if key not in all_params:
|
|
310
|
+
raise TypeError(
|
|
311
|
+
"Got an unexpected keyword argument '%s'"
|
|
312
|
+
" to method delete_entity_group_using_delete" % key
|
|
313
|
+
)
|
|
314
|
+
params[key] = val
|
|
315
|
+
del params['kwargs']
|
|
316
|
+
# verify the required parameter 'entity_group_id' is set
|
|
317
|
+
if ('entity_group_id' not in params or
|
|
318
|
+
params['entity_group_id'] is None):
|
|
319
|
+
raise ValueError("Missing the required parameter `entity_group_id` when calling `delete_entity_group_using_delete`") # noqa: E501
|
|
320
|
+
|
|
321
|
+
collection_formats = {}
|
|
322
|
+
|
|
323
|
+
path_params = {}
|
|
324
|
+
if 'entity_group_id' in params:
|
|
325
|
+
path_params['entityGroupId'] = params['entity_group_id'] # noqa: E501
|
|
326
|
+
|
|
327
|
+
query_params = []
|
|
328
|
+
|
|
329
|
+
header_params = {}
|
|
330
|
+
|
|
331
|
+
form_params = []
|
|
332
|
+
local_var_files = {}
|
|
333
|
+
|
|
334
|
+
body_params = None
|
|
335
|
+
# HTTP header `Accept`
|
|
336
|
+
header_params['Accept'] = self.api_client.select_header_accept(
|
|
337
|
+
['application/json']) # noqa: E501
|
|
338
|
+
|
|
339
|
+
# Authentication setting
|
|
340
|
+
auth_settings = ['X-Authorization'] # noqa: E501
|
|
341
|
+
|
|
342
|
+
return self.api_client.call_api(
|
|
343
|
+
'/api/entityGroup/{entityGroupId}', 'DELETE',
|
|
344
|
+
path_params,
|
|
345
|
+
query_params,
|
|
346
|
+
header_params,
|
|
347
|
+
body=body_params,
|
|
348
|
+
post_params=form_params,
|
|
349
|
+
files=local_var_files,
|
|
350
|
+
response_type=None, # noqa: E501
|
|
351
|
+
auth_settings=auth_settings,
|
|
352
|
+
async_req=params.get('async_req'),
|
|
353
|
+
_return_http_data_only=params.get('_return_http_data_only'),
|
|
354
|
+
_preload_content=params.get('_preload_content', True),
|
|
355
|
+
_request_timeout=params.get('_request_timeout'),
|
|
356
|
+
collection_formats=collection_formats)
|
|
357
|
+
|
|
358
|
+
def get_all_edge_entity_groups_using_get(self, edge_id, group_type, **kwargs): # noqa: E501
|
|
359
|
+
"""Get All Edge Entity Groups by entity type (getAllEdgeEntityGroups) # noqa: E501
|
|
360
|
+
|
|
361
|
+
Fetch the list of Entity Group Info objects based on the provided Entity Type and assigned to the provided Edge entity. Entity group allows you to group multiple entities of the same entity type (Device, Asset, Customer, User, Dashboard, etc). Entity Group always have an owner - particular Tenant or Customer. Each entity may belong to multiple groups simultaneously.Entity Group Info extends Entity Group object and adds 'ownerIds' - a list of owner ids. Available for users with 'TENANT_ADMIN' or 'CUSTOMER_USER' authority. Security check is performed to verify that the user has 'READ' permission for the entity (entities). # noqa: E501
|
|
362
|
+
This method makes a synchronous HTTP request by default. To make an
|
|
363
|
+
asynchronous HTTP request, please pass async_req=True
|
|
364
|
+
>>> thread = api.get_all_edge_entity_groups_using_get(edge_id, group_type, async_req=True)
|
|
365
|
+
>>> result = thread.get()
|
|
366
|
+
|
|
367
|
+
:param async_req bool
|
|
368
|
+
:param str edge_id: A string value representing the edge id. For example, '784f394c-42b6-435a-983c-b7beff2784f9' (required)
|
|
369
|
+
:param str group_type: EntityGroup type (required)
|
|
370
|
+
:return: list[EntityGroupInfo]
|
|
371
|
+
If the method is called asynchronously,
|
|
372
|
+
returns the request thread.
|
|
373
|
+
"""
|
|
374
|
+
kwargs['_return_http_data_only'] = True
|
|
375
|
+
if kwargs.get('async_req'):
|
|
376
|
+
return self.get_all_edge_entity_groups_using_get_with_http_info(edge_id, group_type, **kwargs) # noqa: E501
|
|
377
|
+
else:
|
|
378
|
+
(data) = self.get_all_edge_entity_groups_using_get_with_http_info(edge_id, group_type, **kwargs) # noqa: E501
|
|
379
|
+
return data
|
|
380
|
+
|
|
381
|
+
def get_all_edge_entity_groups_using_get_with_http_info(self, edge_id, group_type, **kwargs): # noqa: E501
|
|
382
|
+
"""Get All Edge Entity Groups by entity type (getAllEdgeEntityGroups) # noqa: E501
|
|
383
|
+
|
|
384
|
+
Fetch the list of Entity Group Info objects based on the provided Entity Type and assigned to the provided Edge entity. Entity group allows you to group multiple entities of the same entity type (Device, Asset, Customer, User, Dashboard, etc). Entity Group always have an owner - particular Tenant or Customer. Each entity may belong to multiple groups simultaneously.Entity Group Info extends Entity Group object and adds 'ownerIds' - a list of owner ids. Available for users with 'TENANT_ADMIN' or 'CUSTOMER_USER' authority. Security check is performed to verify that the user has 'READ' permission for the entity (entities). # noqa: E501
|
|
385
|
+
This method makes a synchronous HTTP request by default. To make an
|
|
386
|
+
asynchronous HTTP request, please pass async_req=True
|
|
387
|
+
>>> thread = api.get_all_edge_entity_groups_using_get_with_http_info(edge_id, group_type, async_req=True)
|
|
388
|
+
>>> result = thread.get()
|
|
389
|
+
|
|
390
|
+
:param async_req bool
|
|
391
|
+
:param str edge_id: A string value representing the edge id. For example, '784f394c-42b6-435a-983c-b7beff2784f9' (required)
|
|
392
|
+
:param str group_type: EntityGroup type (required)
|
|
393
|
+
:return: list[EntityGroupInfo]
|
|
394
|
+
If the method is called asynchronously,
|
|
395
|
+
returns the request thread.
|
|
396
|
+
"""
|
|
397
|
+
|
|
398
|
+
all_params = ['edge_id', 'group_type'] # noqa: E501
|
|
399
|
+
all_params.append('async_req')
|
|
400
|
+
all_params.append('_return_http_data_only')
|
|
401
|
+
all_params.append('_preload_content')
|
|
402
|
+
all_params.append('_request_timeout')
|
|
403
|
+
|
|
404
|
+
params = locals()
|
|
405
|
+
for key, val in six.iteritems(params['kwargs']):
|
|
406
|
+
if key not in all_params:
|
|
407
|
+
raise TypeError(
|
|
408
|
+
"Got an unexpected keyword argument '%s'"
|
|
409
|
+
" to method get_all_edge_entity_groups_using_get" % key
|
|
410
|
+
)
|
|
411
|
+
params[key] = val
|
|
412
|
+
del params['kwargs']
|
|
413
|
+
# verify the required parameter 'edge_id' is set
|
|
414
|
+
if ('edge_id' not in params or
|
|
415
|
+
params['edge_id'] is None):
|
|
416
|
+
raise ValueError("Missing the required parameter `edge_id` when calling `get_all_edge_entity_groups_using_get`") # noqa: E501
|
|
417
|
+
# verify the required parameter 'group_type' is set
|
|
418
|
+
if ('group_type' not in params or
|
|
419
|
+
params['group_type'] is None):
|
|
420
|
+
raise ValueError("Missing the required parameter `group_type` when calling `get_all_edge_entity_groups_using_get`") # noqa: E501
|
|
421
|
+
|
|
422
|
+
collection_formats = {}
|
|
423
|
+
|
|
424
|
+
path_params = {}
|
|
425
|
+
if 'edge_id' in params:
|
|
426
|
+
path_params['edgeId'] = params['edge_id'] # noqa: E501
|
|
427
|
+
if 'group_type' in params:
|
|
428
|
+
path_params['groupType'] = params['group_type'] # noqa: E501
|
|
429
|
+
|
|
430
|
+
query_params = []
|
|
431
|
+
|
|
432
|
+
header_params = {}
|
|
433
|
+
|
|
434
|
+
form_params = []
|
|
435
|
+
local_var_files = {}
|
|
436
|
+
|
|
437
|
+
body_params = None
|
|
438
|
+
# HTTP header `Accept`
|
|
439
|
+
header_params['Accept'] = self.api_client.select_header_accept(
|
|
440
|
+
['application/json']) # noqa: E501
|
|
441
|
+
|
|
442
|
+
# Authentication setting
|
|
443
|
+
auth_settings = ['X-Authorization'] # noqa: E501
|
|
444
|
+
|
|
445
|
+
return self.api_client.call_api(
|
|
446
|
+
'/api/allEntityGroups/edge/{edgeId}/{groupType}', 'GET',
|
|
447
|
+
path_params,
|
|
448
|
+
query_params,
|
|
449
|
+
header_params,
|
|
450
|
+
body=body_params,
|
|
451
|
+
post_params=form_params,
|
|
452
|
+
files=local_var_files,
|
|
453
|
+
response_type='list[EntityGroupInfo]', # noqa: E501
|
|
454
|
+
auth_settings=auth_settings,
|
|
455
|
+
async_req=params.get('async_req'),
|
|
456
|
+
_return_http_data_only=params.get('_return_http_data_only'),
|
|
457
|
+
_preload_content=params.get('_preload_content', True),
|
|
458
|
+
_request_timeout=params.get('_request_timeout'),
|
|
459
|
+
collection_formats=collection_formats)
|
|
460
|
+
|
|
461
|
+
def get_edge_entity_groups_using_get(self, edge_id, group_type, page_size, page, **kwargs): # noqa: E501
|
|
462
|
+
"""Get Edge Entity Groups by entity type (getEdgeEntityGroups) # noqa: E501
|
|
463
|
+
|
|
464
|
+
Returns a page of Entity Group Info objects based on the provided Entity Type and assigned to the provided Edge entity. Entity group allows you to group multiple entities of the same entity type (Device, Asset, Customer, User, Dashboard, etc). Entity Group always have an owner - particular Tenant or Customer. Each entity may belong to multiple groups simultaneously.Entity Group Info extends Entity Group object and adds 'ownerIds' - a list of owner ids.You can specify parameters to filter the results. The result is wrapped with PageData object that allows you to iterate over result set using pagination. See the 'Model' tab of the Response Class for more details. Available for users with 'TENANT_ADMIN' or 'CUSTOMER_USER' authority. Security check is performed to verify that the user has 'READ' permission for the entity (entities). # noqa: E501
|
|
465
|
+
This method makes a synchronous HTTP request by default. To make an
|
|
466
|
+
asynchronous HTTP request, please pass async_req=True
|
|
467
|
+
>>> thread = api.get_edge_entity_groups_using_get(edge_id, group_type, page_size, page, async_req=True)
|
|
468
|
+
>>> result = thread.get()
|
|
469
|
+
|
|
470
|
+
:param async_req bool
|
|
471
|
+
:param str edge_id: A string value representing the edge id. For example, '784f394c-42b6-435a-983c-b7beff2784f9' (required)
|
|
472
|
+
:param str group_type: EntityGroup type (required)
|
|
473
|
+
:param int page_size: Maximum amount of entities in a one page (required)
|
|
474
|
+
:param int page: Sequence number of page starting from 0 (required)
|
|
475
|
+
:param str text_search: The case insensitive 'startsWith' filter based on the entity group name.
|
|
476
|
+
:param str sort_property: Property of entity to sort by
|
|
477
|
+
:param str sort_order: Sort order. ASC (ASCENDING) or DESC (DESCENDING)
|
|
478
|
+
:return: PageDataEntityGroupInfo
|
|
479
|
+
If the method is called asynchronously,
|
|
480
|
+
returns the request thread.
|
|
481
|
+
"""
|
|
482
|
+
kwargs['_return_http_data_only'] = True
|
|
483
|
+
if kwargs.get('async_req'):
|
|
484
|
+
return self.get_edge_entity_groups_using_get_with_http_info(edge_id, group_type, page_size, page, **kwargs) # noqa: E501
|
|
485
|
+
else:
|
|
486
|
+
(data) = self.get_edge_entity_groups_using_get_with_http_info(edge_id, group_type, page_size, page, **kwargs) # noqa: E501
|
|
487
|
+
return data
|
|
488
|
+
|
|
489
|
+
def get_edge_entity_groups_using_get_with_http_info(self, edge_id, group_type, page_size, page, **kwargs): # noqa: E501
|
|
490
|
+
"""Get Edge Entity Groups by entity type (getEdgeEntityGroups) # noqa: E501
|
|
491
|
+
|
|
492
|
+
Returns a page of Entity Group Info objects based on the provided Entity Type and assigned to the provided Edge entity. Entity group allows you to group multiple entities of the same entity type (Device, Asset, Customer, User, Dashboard, etc). Entity Group always have an owner - particular Tenant or Customer. Each entity may belong to multiple groups simultaneously.Entity Group Info extends Entity Group object and adds 'ownerIds' - a list of owner ids.You can specify parameters to filter the results. The result is wrapped with PageData object that allows you to iterate over result set using pagination. See the 'Model' tab of the Response Class for more details. Available for users with 'TENANT_ADMIN' or 'CUSTOMER_USER' authority. Security check is performed to verify that the user has 'READ' permission for the entity (entities). # noqa: E501
|
|
493
|
+
This method makes a synchronous HTTP request by default. To make an
|
|
494
|
+
asynchronous HTTP request, please pass async_req=True
|
|
495
|
+
>>> thread = api.get_edge_entity_groups_using_get_with_http_info(edge_id, group_type, page_size, page, async_req=True)
|
|
496
|
+
>>> result = thread.get()
|
|
497
|
+
|
|
498
|
+
:param async_req bool
|
|
499
|
+
:param str edge_id: A string value representing the edge id. For example, '784f394c-42b6-435a-983c-b7beff2784f9' (required)
|
|
500
|
+
:param str group_type: EntityGroup type (required)
|
|
501
|
+
:param int page_size: Maximum amount of entities in a one page (required)
|
|
502
|
+
:param int page: Sequence number of page starting from 0 (required)
|
|
503
|
+
:param str text_search: The case insensitive 'startsWith' filter based on the entity group name.
|
|
504
|
+
:param str sort_property: Property of entity to sort by
|
|
505
|
+
:param str sort_order: Sort order. ASC (ASCENDING) or DESC (DESCENDING)
|
|
506
|
+
:return: PageDataEntityGroupInfo
|
|
507
|
+
If the method is called asynchronously,
|
|
508
|
+
returns the request thread.
|
|
509
|
+
"""
|
|
510
|
+
|
|
511
|
+
all_params = ['edge_id', 'group_type', 'page_size', 'page', 'text_search', 'sort_property', 'sort_order'] # noqa: E501
|
|
512
|
+
all_params.append('async_req')
|
|
513
|
+
all_params.append('_return_http_data_only')
|
|
514
|
+
all_params.append('_preload_content')
|
|
515
|
+
all_params.append('_request_timeout')
|
|
516
|
+
|
|
517
|
+
params = locals()
|
|
518
|
+
for key, val in six.iteritems(params['kwargs']):
|
|
519
|
+
if key not in all_params:
|
|
520
|
+
raise TypeError(
|
|
521
|
+
"Got an unexpected keyword argument '%s'"
|
|
522
|
+
" to method get_edge_entity_groups_using_get" % key
|
|
523
|
+
)
|
|
524
|
+
params[key] = val
|
|
525
|
+
del params['kwargs']
|
|
526
|
+
# verify the required parameter 'edge_id' is set
|
|
527
|
+
if ('edge_id' not in params or
|
|
528
|
+
params['edge_id'] is None):
|
|
529
|
+
raise ValueError("Missing the required parameter `edge_id` when calling `get_edge_entity_groups_using_get`") # noqa: E501
|
|
530
|
+
# verify the required parameter 'group_type' is set
|
|
531
|
+
if ('group_type' not in params or
|
|
532
|
+
params['group_type'] is None):
|
|
533
|
+
raise ValueError("Missing the required parameter `group_type` when calling `get_edge_entity_groups_using_get`") # noqa: E501
|
|
534
|
+
# verify the required parameter 'page_size' is set
|
|
535
|
+
if ('page_size' not in params or
|
|
536
|
+
params['page_size'] is None):
|
|
537
|
+
raise ValueError("Missing the required parameter `page_size` when calling `get_edge_entity_groups_using_get`") # noqa: E501
|
|
538
|
+
# verify the required parameter 'page' is set
|
|
539
|
+
if ('page' not in params or
|
|
540
|
+
params['page'] is None):
|
|
541
|
+
raise ValueError("Missing the required parameter `page` when calling `get_edge_entity_groups_using_get`") # noqa: E501
|
|
542
|
+
|
|
543
|
+
collection_formats = {}
|
|
544
|
+
|
|
545
|
+
path_params = {}
|
|
546
|
+
if 'edge_id' in params:
|
|
547
|
+
path_params['edgeId'] = params['edge_id'] # noqa: E501
|
|
548
|
+
if 'group_type' in params:
|
|
549
|
+
path_params['groupType'] = params['group_type'] # noqa: E501
|
|
550
|
+
|
|
551
|
+
query_params = []
|
|
552
|
+
if 'page_size' in params:
|
|
553
|
+
query_params.append(('pageSize', params['page_size'])) # noqa: E501
|
|
554
|
+
if 'page' in params:
|
|
555
|
+
query_params.append(('page', params['page'])) # noqa: E501
|
|
556
|
+
if 'text_search' in params:
|
|
557
|
+
query_params.append(('textSearch', params['text_search'])) # noqa: E501
|
|
558
|
+
if 'sort_property' in params:
|
|
559
|
+
query_params.append(('sortProperty', params['sort_property'])) # noqa: E501
|
|
560
|
+
if 'sort_order' in params:
|
|
561
|
+
query_params.append(('sortOrder', params['sort_order'])) # noqa: E501
|
|
562
|
+
|
|
563
|
+
header_params = {}
|
|
564
|
+
|
|
565
|
+
form_params = []
|
|
566
|
+
local_var_files = {}
|
|
567
|
+
|
|
568
|
+
body_params = None
|
|
569
|
+
# HTTP header `Accept`
|
|
570
|
+
header_params['Accept'] = self.api_client.select_header_accept(
|
|
571
|
+
['application/json']) # noqa: E501
|
|
572
|
+
|
|
573
|
+
# Authentication setting
|
|
574
|
+
auth_settings = ['X-Authorization'] # noqa: E501
|
|
575
|
+
|
|
576
|
+
return self.api_client.call_api(
|
|
577
|
+
'/api/entityGroups/edge/{edgeId}/{groupType}{?page,pageSize,sortOrder,sortProperty,textSearch}', 'GET',
|
|
578
|
+
path_params,
|
|
579
|
+
query_params,
|
|
580
|
+
header_params,
|
|
581
|
+
body=body_params,
|
|
582
|
+
post_params=form_params,
|
|
583
|
+
files=local_var_files,
|
|
584
|
+
response_type='PageDataEntityGroupInfo', # noqa: E501
|
|
585
|
+
auth_settings=auth_settings,
|
|
586
|
+
async_req=params.get('async_req'),
|
|
587
|
+
_return_http_data_only=params.get('_return_http_data_only'),
|
|
588
|
+
_preload_content=params.get('_preload_content', True),
|
|
589
|
+
_request_timeout=params.get('_request_timeout'),
|
|
590
|
+
collection_formats=collection_formats)
|
|
591
|
+
|
|
592
|
+
def get_entities_using_get(self, entity_group_id, page_size, page, **kwargs): # noqa: E501
|
|
593
|
+
"""Get Group Entities (getEntities) # noqa: E501
|
|
594
|
+
|
|
595
|
+
Returns a page of Short Entity View objects that belongs to specified Entity Group Id. Short Entity View object contains the entity id and number of fields (attributes, telemetry, etc). List of those fields is configurable and defined in the group configuration.You can specify parameters to filter the results. The result is wrapped with PageData object that allows you to iterate over result set using pagination. See the 'Model' tab of the Response Class for more details. Available for users with 'TENANT_ADMIN' or 'CUSTOMER_USER' authority. Security check is performed to verify that the user has 'READ' permission for specified group. # noqa: E501
|
|
596
|
+
This method makes a synchronous HTTP request by default. To make an
|
|
597
|
+
asynchronous HTTP request, please pass async_req=True
|
|
598
|
+
>>> thread = api.get_entities_using_get(entity_group_id, page_size, page, async_req=True)
|
|
599
|
+
>>> result = thread.get()
|
|
600
|
+
|
|
601
|
+
:param async_req bool
|
|
602
|
+
:param str entity_group_id: A string value representing the Entity Group Id. For example, '784f394c-42b6-435a-983c-b7beff2784f9' (required)
|
|
603
|
+
:param int page_size: Maximum amount of entities in a one page (required)
|
|
604
|
+
:param int page: Sequence number of page starting from 0 (required)
|
|
605
|
+
:param str text_search: The case insensitive 'startsWith' filter based on the entity group name.
|
|
606
|
+
:param str sort_property: Property of entity to sort by
|
|
607
|
+
:param str sort_order: Sort order. ASC (ASCENDING) or DESC (DESCENDING)
|
|
608
|
+
:return: PageDataShortEntityView
|
|
609
|
+
If the method is called asynchronously,
|
|
610
|
+
returns the request thread.
|
|
611
|
+
"""
|
|
612
|
+
kwargs['_return_http_data_only'] = True
|
|
613
|
+
if kwargs.get('async_req'):
|
|
614
|
+
return self.get_entities_using_get_with_http_info(entity_group_id, page_size, page, **kwargs) # noqa: E501
|
|
615
|
+
else:
|
|
616
|
+
(data) = self.get_entities_using_get_with_http_info(entity_group_id, page_size, page, **kwargs) # noqa: E501
|
|
617
|
+
return data
|
|
618
|
+
|
|
619
|
+
def get_entities_using_get_with_http_info(self, entity_group_id, page_size, page, **kwargs): # noqa: E501
|
|
620
|
+
"""Get Group Entities (getEntities) # noqa: E501
|
|
621
|
+
|
|
622
|
+
Returns a page of Short Entity View objects that belongs to specified Entity Group Id. Short Entity View object contains the entity id and number of fields (attributes, telemetry, etc). List of those fields is configurable and defined in the group configuration.You can specify parameters to filter the results. The result is wrapped with PageData object that allows you to iterate over result set using pagination. See the 'Model' tab of the Response Class for more details. Available for users with 'TENANT_ADMIN' or 'CUSTOMER_USER' authority. Security check is performed to verify that the user has 'READ' permission for specified group. # noqa: E501
|
|
623
|
+
This method makes a synchronous HTTP request by default. To make an
|
|
624
|
+
asynchronous HTTP request, please pass async_req=True
|
|
625
|
+
>>> thread = api.get_entities_using_get_with_http_info(entity_group_id, page_size, page, async_req=True)
|
|
626
|
+
>>> result = thread.get()
|
|
627
|
+
|
|
628
|
+
:param async_req bool
|
|
629
|
+
:param str entity_group_id: A string value representing the Entity Group Id. For example, '784f394c-42b6-435a-983c-b7beff2784f9' (required)
|
|
630
|
+
:param int page_size: Maximum amount of entities in a one page (required)
|
|
631
|
+
:param int page: Sequence number of page starting from 0 (required)
|
|
632
|
+
:param str text_search: The case insensitive 'startsWith' filter based on the entity group name.
|
|
633
|
+
:param str sort_property: Property of entity to sort by
|
|
634
|
+
:param str sort_order: Sort order. ASC (ASCENDING) or DESC (DESCENDING)
|
|
635
|
+
:return: PageDataShortEntityView
|
|
636
|
+
If the method is called asynchronously,
|
|
637
|
+
returns the request thread.
|
|
638
|
+
"""
|
|
639
|
+
|
|
640
|
+
all_params = ['entity_group_id', 'page_size', 'page', 'text_search', 'sort_property', 'sort_order'] # noqa: E501
|
|
641
|
+
all_params.append('async_req')
|
|
642
|
+
all_params.append('_return_http_data_only')
|
|
643
|
+
all_params.append('_preload_content')
|
|
644
|
+
all_params.append('_request_timeout')
|
|
645
|
+
|
|
646
|
+
params = locals()
|
|
647
|
+
for key, val in six.iteritems(params['kwargs']):
|
|
648
|
+
if key not in all_params:
|
|
649
|
+
raise TypeError(
|
|
650
|
+
"Got an unexpected keyword argument '%s'"
|
|
651
|
+
" to method get_entities_using_get" % key
|
|
652
|
+
)
|
|
653
|
+
params[key] = val
|
|
654
|
+
del params['kwargs']
|
|
655
|
+
# verify the required parameter 'entity_group_id' is set
|
|
656
|
+
if ('entity_group_id' not in params or
|
|
657
|
+
params['entity_group_id'] is None):
|
|
658
|
+
raise ValueError("Missing the required parameter `entity_group_id` when calling `get_entities_using_get`") # noqa: E501
|
|
659
|
+
# verify the required parameter 'page_size' is set
|
|
660
|
+
if ('page_size' not in params or
|
|
661
|
+
params['page_size'] is None):
|
|
662
|
+
raise ValueError("Missing the required parameter `page_size` when calling `get_entities_using_get`") # noqa: E501
|
|
663
|
+
# verify the required parameter 'page' is set
|
|
664
|
+
if ('page' not in params or
|
|
665
|
+
params['page'] is None):
|
|
666
|
+
raise ValueError("Missing the required parameter `page` when calling `get_entities_using_get`") # noqa: E501
|
|
667
|
+
|
|
668
|
+
collection_formats = {}
|
|
669
|
+
|
|
670
|
+
path_params = {}
|
|
671
|
+
if 'entity_group_id' in params:
|
|
672
|
+
path_params['entityGroupId'] = params['entity_group_id'] # noqa: E501
|
|
673
|
+
|
|
674
|
+
query_params = []
|
|
675
|
+
if 'page_size' in params:
|
|
676
|
+
query_params.append(('pageSize', params['page_size'])) # noqa: E501
|
|
677
|
+
if 'page' in params:
|
|
678
|
+
query_params.append(('page', params['page'])) # noqa: E501
|
|
679
|
+
if 'text_search' in params:
|
|
680
|
+
query_params.append(('textSearch', params['text_search'])) # noqa: E501
|
|
681
|
+
if 'sort_property' in params:
|
|
682
|
+
query_params.append(('sortProperty', params['sort_property'])) # noqa: E501
|
|
683
|
+
if 'sort_order' in params:
|
|
684
|
+
query_params.append(('sortOrder', params['sort_order'])) # noqa: E501
|
|
685
|
+
|
|
686
|
+
header_params = {}
|
|
687
|
+
|
|
688
|
+
form_params = []
|
|
689
|
+
local_var_files = {}
|
|
690
|
+
|
|
691
|
+
body_params = None
|
|
692
|
+
# HTTP header `Accept`
|
|
693
|
+
header_params['Accept'] = self.api_client.select_header_accept(
|
|
694
|
+
['application/json']) # noqa: E501
|
|
695
|
+
|
|
696
|
+
# Authentication setting
|
|
697
|
+
auth_settings = ['X-Authorization'] # noqa: E501
|
|
698
|
+
|
|
699
|
+
return self.api_client.call_api(
|
|
700
|
+
'/api/entityGroup/{entityGroupId}/entities{?page,pageSize,sortOrder,sortProperty,textSearch}', 'GET',
|
|
701
|
+
path_params,
|
|
702
|
+
query_params,
|
|
703
|
+
header_params,
|
|
704
|
+
body=body_params,
|
|
705
|
+
post_params=form_params,
|
|
706
|
+
files=local_var_files,
|
|
707
|
+
response_type='PageDataShortEntityView', # noqa: E501
|
|
708
|
+
auth_settings=auth_settings,
|
|
709
|
+
async_req=params.get('async_req'),
|
|
710
|
+
_return_http_data_only=params.get('_return_http_data_only'),
|
|
711
|
+
_preload_content=params.get('_preload_content', True),
|
|
712
|
+
_request_timeout=params.get('_request_timeout'),
|
|
713
|
+
collection_formats=collection_formats)
|
|
714
|
+
|
|
715
|
+
def get_entity_group_all_by_owner_and_type_using_get(self, owner_type, owner_id, group_type, **kwargs): # noqa: E501
|
|
716
|
+
"""Get special group All by owner and entity type (getEntityGroupsByOwnerAndType) # noqa: E501
|
|
717
|
+
|
|
718
|
+
Fetch reserved group 'All' based on the provided Owner Id and Entity Type. Entity group allows you to group multiple entities of the same entity type (Device, Asset, Customer, User, Dashboard, etc). Entity Group always have an owner - particular Tenant or Customer. Each entity may belong to multiple groups simultaneously.Entity Group Info extends Entity Group object and adds 'ownerIds' - a list of owner ids. Available for users with 'TENANT_ADMIN' or 'CUSTOMER_USER' authority. Security check is performed to verify that the user has 'READ' permission for specified group. # noqa: E501
|
|
719
|
+
This method makes a synchronous HTTP request by default. To make an
|
|
720
|
+
asynchronous HTTP request, please pass async_req=True
|
|
721
|
+
>>> thread = api.get_entity_group_all_by_owner_and_type_using_get(owner_type, owner_id, group_type, async_req=True)
|
|
722
|
+
>>> result = thread.get()
|
|
723
|
+
|
|
724
|
+
:param async_req bool
|
|
725
|
+
:param str owner_type: Tenant or Customer (required)
|
|
726
|
+
:param str owner_id: A string value representing the Tenant or Customer id (required)
|
|
727
|
+
:param str group_type: Entity Group type (required)
|
|
728
|
+
:return: EntityGroupInfo
|
|
729
|
+
If the method is called asynchronously,
|
|
730
|
+
returns the request thread.
|
|
731
|
+
"""
|
|
732
|
+
kwargs['_return_http_data_only'] = True
|
|
733
|
+
if kwargs.get('async_req'):
|
|
734
|
+
return self.get_entity_group_all_by_owner_and_type_using_get_with_http_info(owner_type, owner_id, group_type, **kwargs) # noqa: E501
|
|
735
|
+
else:
|
|
736
|
+
(data) = self.get_entity_group_all_by_owner_and_type_using_get_with_http_info(owner_type, owner_id, group_type, **kwargs) # noqa: E501
|
|
737
|
+
return data
|
|
738
|
+
|
|
739
|
+
def get_entity_group_all_by_owner_and_type_using_get_with_http_info(self, owner_type, owner_id, group_type, **kwargs): # noqa: E501
|
|
740
|
+
"""Get special group All by owner and entity type (getEntityGroupsByOwnerAndType) # noqa: E501
|
|
741
|
+
|
|
742
|
+
Fetch reserved group 'All' based on the provided Owner Id and Entity Type. Entity group allows you to group multiple entities of the same entity type (Device, Asset, Customer, User, Dashboard, etc). Entity Group always have an owner - particular Tenant or Customer. Each entity may belong to multiple groups simultaneously.Entity Group Info extends Entity Group object and adds 'ownerIds' - a list of owner ids. Available for users with 'TENANT_ADMIN' or 'CUSTOMER_USER' authority. Security check is performed to verify that the user has 'READ' permission for specified group. # noqa: E501
|
|
743
|
+
This method makes a synchronous HTTP request by default. To make an
|
|
744
|
+
asynchronous HTTP request, please pass async_req=True
|
|
745
|
+
>>> thread = api.get_entity_group_all_by_owner_and_type_using_get_with_http_info(owner_type, owner_id, group_type, async_req=True)
|
|
746
|
+
>>> result = thread.get()
|
|
747
|
+
|
|
748
|
+
:param async_req bool
|
|
749
|
+
:param str owner_type: Tenant or Customer (required)
|
|
750
|
+
:param str owner_id: A string value representing the Tenant or Customer id (required)
|
|
751
|
+
:param str group_type: Entity Group type (required)
|
|
752
|
+
:return: EntityGroupInfo
|
|
753
|
+
If the method is called asynchronously,
|
|
754
|
+
returns the request thread.
|
|
755
|
+
"""
|
|
756
|
+
|
|
757
|
+
all_params = ['owner_type', 'owner_id', 'group_type'] # noqa: E501
|
|
758
|
+
all_params.append('async_req')
|
|
759
|
+
all_params.append('_return_http_data_only')
|
|
760
|
+
all_params.append('_preload_content')
|
|
761
|
+
all_params.append('_request_timeout')
|
|
762
|
+
|
|
763
|
+
params = locals()
|
|
764
|
+
for key, val in six.iteritems(params['kwargs']):
|
|
765
|
+
if key not in all_params:
|
|
766
|
+
raise TypeError(
|
|
767
|
+
"Got an unexpected keyword argument '%s'"
|
|
768
|
+
" to method get_entity_group_all_by_owner_and_type_using_get" % key
|
|
769
|
+
)
|
|
770
|
+
params[key] = val
|
|
771
|
+
del params['kwargs']
|
|
772
|
+
# verify the required parameter 'owner_type' is set
|
|
773
|
+
if ('owner_type' not in params or
|
|
774
|
+
params['owner_type'] is None):
|
|
775
|
+
raise ValueError("Missing the required parameter `owner_type` when calling `get_entity_group_all_by_owner_and_type_using_get`") # noqa: E501
|
|
776
|
+
# verify the required parameter 'owner_id' is set
|
|
777
|
+
if ('owner_id' not in params or
|
|
778
|
+
params['owner_id'] is None):
|
|
779
|
+
raise ValueError("Missing the required parameter `owner_id` when calling `get_entity_group_all_by_owner_and_type_using_get`") # noqa: E501
|
|
780
|
+
# verify the required parameter 'group_type' is set
|
|
781
|
+
if ('group_type' not in params or
|
|
782
|
+
params['group_type'] is None):
|
|
783
|
+
raise ValueError("Missing the required parameter `group_type` when calling `get_entity_group_all_by_owner_and_type_using_get`") # noqa: E501
|
|
784
|
+
|
|
785
|
+
collection_formats = {}
|
|
786
|
+
|
|
787
|
+
path_params = {}
|
|
788
|
+
if 'owner_type' in params:
|
|
789
|
+
path_params['ownerType'] = params['owner_type'] # noqa: E501
|
|
790
|
+
if 'owner_id' in params:
|
|
791
|
+
path_params['ownerId'] = params['owner_id'] # noqa: E501
|
|
792
|
+
if 'group_type' in params:
|
|
793
|
+
path_params['groupType'] = params['group_type'] # noqa: E501
|
|
794
|
+
|
|
795
|
+
query_params = []
|
|
796
|
+
|
|
797
|
+
header_params = {}
|
|
798
|
+
|
|
799
|
+
form_params = []
|
|
800
|
+
local_var_files = {}
|
|
801
|
+
|
|
802
|
+
body_params = None
|
|
803
|
+
# HTTP header `Accept`
|
|
804
|
+
header_params['Accept'] = self.api_client.select_header_accept(
|
|
805
|
+
['application/json']) # noqa: E501
|
|
806
|
+
|
|
807
|
+
# Authentication setting
|
|
808
|
+
auth_settings = ['X-Authorization'] # noqa: E501
|
|
809
|
+
|
|
810
|
+
return self.api_client.call_api(
|
|
811
|
+
'/api/entityGroup/all/{ownerType}/{ownerId}/{groupType}', 'GET',
|
|
812
|
+
path_params,
|
|
813
|
+
query_params,
|
|
814
|
+
header_params,
|
|
815
|
+
body=body_params,
|
|
816
|
+
post_params=form_params,
|
|
817
|
+
files=local_var_files,
|
|
818
|
+
response_type='EntityGroupInfo', # noqa: E501
|
|
819
|
+
auth_settings=auth_settings,
|
|
820
|
+
async_req=params.get('async_req'),
|
|
821
|
+
_return_http_data_only=params.get('_return_http_data_only'),
|
|
822
|
+
_preload_content=params.get('_preload_content', True),
|
|
823
|
+
_request_timeout=params.get('_request_timeout'),
|
|
824
|
+
collection_formats=collection_formats)
|
|
825
|
+
|
|
826
|
+
def get_entity_group_by_id_using_get(self, entity_group_id, **kwargs): # noqa: E501
|
|
827
|
+
"""Get Entity Group Info (getEntityGroupById) # noqa: E501
|
|
828
|
+
|
|
829
|
+
Fetch the Entity Group object based on the provided Entity Group Id. Entity group allows you to group multiple entities of the same entity type (Device, Asset, Customer, User, Dashboard, etc). Entity Group always have an owner - particular Tenant or Customer. Each entity may belong to multiple groups simultaneously.Entity Group Info extends Entity Group object and adds 'ownerIds' - a list of owner ids. Entity group name is unique in the scope of owner and entity type. For example, you can't create two tenant device groups called 'Water meters'. However, you may create device and asset group with the same name. And also you may create groups with the same name for two different customers of the same tenant. Available for users with 'TENANT_ADMIN' or 'CUSTOMER_USER' authority. Security check is performed to verify that the user has 'READ' permission for specified group. # noqa: E501
|
|
830
|
+
This method makes a synchronous HTTP request by default. To make an
|
|
831
|
+
asynchronous HTTP request, please pass async_req=True
|
|
832
|
+
>>> thread = api.get_entity_group_by_id_using_get(entity_group_id, async_req=True)
|
|
833
|
+
>>> result = thread.get()
|
|
834
|
+
|
|
835
|
+
:param async_req bool
|
|
836
|
+
:param str entity_group_id: A string value representing the Entity Group Id. For example, '784f394c-42b6-435a-983c-b7beff2784f9' (required)
|
|
837
|
+
:return: EntityGroupInfo
|
|
838
|
+
If the method is called asynchronously,
|
|
839
|
+
returns the request thread.
|
|
840
|
+
"""
|
|
841
|
+
kwargs['_return_http_data_only'] = True
|
|
842
|
+
if kwargs.get('async_req'):
|
|
843
|
+
return self.get_entity_group_by_id_using_get_with_http_info(entity_group_id, **kwargs) # noqa: E501
|
|
844
|
+
else:
|
|
845
|
+
(data) = self.get_entity_group_by_id_using_get_with_http_info(entity_group_id, **kwargs) # noqa: E501
|
|
846
|
+
return data
|
|
847
|
+
|
|
848
|
+
def get_entity_group_by_id_using_get_with_http_info(self, entity_group_id, **kwargs): # noqa: E501
|
|
849
|
+
"""Get Entity Group Info (getEntityGroupById) # noqa: E501
|
|
850
|
+
|
|
851
|
+
Fetch the Entity Group object based on the provided Entity Group Id. Entity group allows you to group multiple entities of the same entity type (Device, Asset, Customer, User, Dashboard, etc). Entity Group always have an owner - particular Tenant or Customer. Each entity may belong to multiple groups simultaneously.Entity Group Info extends Entity Group object and adds 'ownerIds' - a list of owner ids. Entity group name is unique in the scope of owner and entity type. For example, you can't create two tenant device groups called 'Water meters'. However, you may create device and asset group with the same name. And also you may create groups with the same name for two different customers of the same tenant. Available for users with 'TENANT_ADMIN' or 'CUSTOMER_USER' authority. Security check is performed to verify that the user has 'READ' permission for specified group. # noqa: E501
|
|
852
|
+
This method makes a synchronous HTTP request by default. To make an
|
|
853
|
+
asynchronous HTTP request, please pass async_req=True
|
|
854
|
+
>>> thread = api.get_entity_group_by_id_using_get_with_http_info(entity_group_id, async_req=True)
|
|
855
|
+
>>> result = thread.get()
|
|
856
|
+
|
|
857
|
+
:param async_req bool
|
|
858
|
+
:param str entity_group_id: A string value representing the Entity Group Id. For example, '784f394c-42b6-435a-983c-b7beff2784f9' (required)
|
|
859
|
+
:return: EntityGroupInfo
|
|
860
|
+
If the method is called asynchronously,
|
|
861
|
+
returns the request thread.
|
|
862
|
+
"""
|
|
863
|
+
|
|
864
|
+
all_params = ['entity_group_id'] # noqa: E501
|
|
865
|
+
all_params.append('async_req')
|
|
866
|
+
all_params.append('_return_http_data_only')
|
|
867
|
+
all_params.append('_preload_content')
|
|
868
|
+
all_params.append('_request_timeout')
|
|
869
|
+
|
|
870
|
+
params = locals()
|
|
871
|
+
for key, val in six.iteritems(params['kwargs']):
|
|
872
|
+
if key not in all_params:
|
|
873
|
+
raise TypeError(
|
|
874
|
+
"Got an unexpected keyword argument '%s'"
|
|
875
|
+
" to method get_entity_group_by_id_using_get" % key
|
|
876
|
+
)
|
|
877
|
+
params[key] = val
|
|
878
|
+
del params['kwargs']
|
|
879
|
+
# verify the required parameter 'entity_group_id' is set
|
|
880
|
+
if ('entity_group_id' not in params or
|
|
881
|
+
params['entity_group_id'] is None):
|
|
882
|
+
raise ValueError("Missing the required parameter `entity_group_id` when calling `get_entity_group_by_id_using_get`") # noqa: E501
|
|
883
|
+
|
|
884
|
+
collection_formats = {}
|
|
885
|
+
|
|
886
|
+
path_params = {}
|
|
887
|
+
if 'entity_group_id' in params:
|
|
888
|
+
path_params['entityGroupId'] = params['entity_group_id'] # noqa: E501
|
|
889
|
+
|
|
890
|
+
query_params = []
|
|
891
|
+
|
|
892
|
+
header_params = {}
|
|
893
|
+
|
|
894
|
+
form_params = []
|
|
895
|
+
local_var_files = {}
|
|
896
|
+
|
|
897
|
+
body_params = None
|
|
898
|
+
# HTTP header `Accept`
|
|
899
|
+
header_params['Accept'] = self.api_client.select_header_accept(
|
|
900
|
+
['application/json']) # noqa: E501
|
|
901
|
+
|
|
902
|
+
# Authentication setting
|
|
903
|
+
auth_settings = ['X-Authorization'] # noqa: E501
|
|
904
|
+
|
|
905
|
+
return self.api_client.call_api(
|
|
906
|
+
'/api/entityGroup/{entityGroupId}', 'GET',
|
|
907
|
+
path_params,
|
|
908
|
+
query_params,
|
|
909
|
+
header_params,
|
|
910
|
+
body=body_params,
|
|
911
|
+
post_params=form_params,
|
|
912
|
+
files=local_var_files,
|
|
913
|
+
response_type='EntityGroupInfo', # noqa: E501
|
|
914
|
+
auth_settings=auth_settings,
|
|
915
|
+
async_req=params.get('async_req'),
|
|
916
|
+
_return_http_data_only=params.get('_return_http_data_only'),
|
|
917
|
+
_preload_content=params.get('_preload_content', True),
|
|
918
|
+
_request_timeout=params.get('_request_timeout'),
|
|
919
|
+
collection_formats=collection_formats)
|
|
920
|
+
|
|
921
|
+
def get_entity_group_by_owner_and_name_and_type_using_get(self, owner_type, owner_id, group_type, group_name, **kwargs): # noqa: E501
|
|
922
|
+
"""Get Entity Group by owner, type and name (getEntityGroupByOwnerAndNameAndType) # noqa: E501
|
|
923
|
+
|
|
924
|
+
Fetch the Entity Group object based on the provided Entity Group Id. Entity group allows you to group multiple entities of the same entity type (Device, Asset, Customer, User, Dashboard, etc). Entity Group always have an owner - particular Tenant or Customer. Each entity may belong to multiple groups simultaneously.Entity Group Info extends Entity Group object and adds 'ownerIds' - a list of owner ids. Entity group name is unique in the scope of owner and entity type. For example, you can't create two tenant device groups called 'Water meters'. However, you may create device and asset group with the same name. And also you may create groups with the same name for two different customers of the same tenant. Available for users with 'TENANT_ADMIN' or 'CUSTOMER_USER' authority. Security check is performed to verify that the user has 'READ' permission for specified group. # noqa: E501
|
|
925
|
+
This method makes a synchronous HTTP request by default. To make an
|
|
926
|
+
asynchronous HTTP request, please pass async_req=True
|
|
927
|
+
>>> thread = api.get_entity_group_by_owner_and_name_and_type_using_get(owner_type, owner_id, group_type, group_name, async_req=True)
|
|
928
|
+
>>> result = thread.get()
|
|
929
|
+
|
|
930
|
+
:param async_req bool
|
|
931
|
+
:param str owner_type: Tenant or Customer (required)
|
|
932
|
+
:param str owner_id: A string value representing the Tenant or Customer id (required)
|
|
933
|
+
:param str group_type: Entity Group type (required)
|
|
934
|
+
:param str group_name: Entity Group name (required)
|
|
935
|
+
:return: EntityGroupInfo
|
|
936
|
+
If the method is called asynchronously,
|
|
937
|
+
returns the request thread.
|
|
938
|
+
"""
|
|
939
|
+
kwargs['_return_http_data_only'] = True
|
|
940
|
+
if kwargs.get('async_req'):
|
|
941
|
+
return self.get_entity_group_by_owner_and_name_and_type_using_get_with_http_info(owner_type, owner_id, group_type, group_name, **kwargs) # noqa: E501
|
|
942
|
+
else:
|
|
943
|
+
(data) = self.get_entity_group_by_owner_and_name_and_type_using_get_with_http_info(owner_type, owner_id, group_type, group_name, **kwargs) # noqa: E501
|
|
944
|
+
return data
|
|
945
|
+
|
|
946
|
+
def get_entity_group_by_owner_and_name_and_type_using_get_with_http_info(self, owner_type, owner_id, group_type, group_name, **kwargs): # noqa: E501
|
|
947
|
+
"""Get Entity Group by owner, type and name (getEntityGroupByOwnerAndNameAndType) # noqa: E501
|
|
948
|
+
|
|
949
|
+
Fetch the Entity Group object based on the provided Entity Group Id. Entity group allows you to group multiple entities of the same entity type (Device, Asset, Customer, User, Dashboard, etc). Entity Group always have an owner - particular Tenant or Customer. Each entity may belong to multiple groups simultaneously.Entity Group Info extends Entity Group object and adds 'ownerIds' - a list of owner ids. Entity group name is unique in the scope of owner and entity type. For example, you can't create two tenant device groups called 'Water meters'. However, you may create device and asset group with the same name. And also you may create groups with the same name for two different customers of the same tenant. Available for users with 'TENANT_ADMIN' or 'CUSTOMER_USER' authority. Security check is performed to verify that the user has 'READ' permission for specified group. # noqa: E501
|
|
950
|
+
This method makes a synchronous HTTP request by default. To make an
|
|
951
|
+
asynchronous HTTP request, please pass async_req=True
|
|
952
|
+
>>> thread = api.get_entity_group_by_owner_and_name_and_type_using_get_with_http_info(owner_type, owner_id, group_type, group_name, async_req=True)
|
|
953
|
+
>>> result = thread.get()
|
|
954
|
+
|
|
955
|
+
:param async_req bool
|
|
956
|
+
:param str owner_type: Tenant or Customer (required)
|
|
957
|
+
:param str owner_id: A string value representing the Tenant or Customer id (required)
|
|
958
|
+
:param str group_type: Entity Group type (required)
|
|
959
|
+
:param str group_name: Entity Group name (required)
|
|
960
|
+
:return: EntityGroupInfo
|
|
961
|
+
If the method is called asynchronously,
|
|
962
|
+
returns the request thread.
|
|
963
|
+
"""
|
|
964
|
+
|
|
965
|
+
all_params = ['owner_type', 'owner_id', 'group_type', 'group_name'] # noqa: E501
|
|
966
|
+
all_params.append('async_req')
|
|
967
|
+
all_params.append('_return_http_data_only')
|
|
968
|
+
all_params.append('_preload_content')
|
|
969
|
+
all_params.append('_request_timeout')
|
|
970
|
+
|
|
971
|
+
params = locals()
|
|
972
|
+
for key, val in six.iteritems(params['kwargs']):
|
|
973
|
+
if key not in all_params:
|
|
974
|
+
raise TypeError(
|
|
975
|
+
"Got an unexpected keyword argument '%s'"
|
|
976
|
+
" to method get_entity_group_by_owner_and_name_and_type_using_get" % key
|
|
977
|
+
)
|
|
978
|
+
params[key] = val
|
|
979
|
+
del params['kwargs']
|
|
980
|
+
# verify the required parameter 'owner_type' is set
|
|
981
|
+
if ('owner_type' not in params or
|
|
982
|
+
params['owner_type'] is None):
|
|
983
|
+
raise ValueError("Missing the required parameter `owner_type` when calling `get_entity_group_by_owner_and_name_and_type_using_get`") # noqa: E501
|
|
984
|
+
# verify the required parameter 'owner_id' is set
|
|
985
|
+
if ('owner_id' not in params or
|
|
986
|
+
params['owner_id'] is None):
|
|
987
|
+
raise ValueError("Missing the required parameter `owner_id` when calling `get_entity_group_by_owner_and_name_and_type_using_get`") # noqa: E501
|
|
988
|
+
# verify the required parameter 'group_type' is set
|
|
989
|
+
if ('group_type' not in params or
|
|
990
|
+
params['group_type'] is None):
|
|
991
|
+
raise ValueError("Missing the required parameter `group_type` when calling `get_entity_group_by_owner_and_name_and_type_using_get`") # noqa: E501
|
|
992
|
+
# verify the required parameter 'group_name' is set
|
|
993
|
+
if ('group_name' not in params or
|
|
994
|
+
params['group_name'] is None):
|
|
995
|
+
raise ValueError("Missing the required parameter `group_name` when calling `get_entity_group_by_owner_and_name_and_type_using_get`") # noqa: E501
|
|
996
|
+
|
|
997
|
+
collection_formats = {}
|
|
998
|
+
|
|
999
|
+
path_params = {}
|
|
1000
|
+
if 'owner_type' in params:
|
|
1001
|
+
path_params['ownerType'] = params['owner_type'] # noqa: E501
|
|
1002
|
+
if 'owner_id' in params:
|
|
1003
|
+
path_params['ownerId'] = params['owner_id'] # noqa: E501
|
|
1004
|
+
if 'group_type' in params:
|
|
1005
|
+
path_params['groupType'] = params['group_type'] # noqa: E501
|
|
1006
|
+
if 'group_name' in params:
|
|
1007
|
+
path_params['groupName'] = params['group_name'] # noqa: E501
|
|
1008
|
+
|
|
1009
|
+
query_params = []
|
|
1010
|
+
|
|
1011
|
+
header_params = {}
|
|
1012
|
+
|
|
1013
|
+
form_params = []
|
|
1014
|
+
local_var_files = {}
|
|
1015
|
+
|
|
1016
|
+
body_params = None
|
|
1017
|
+
# HTTP header `Accept`
|
|
1018
|
+
header_params['Accept'] = self.api_client.select_header_accept(
|
|
1019
|
+
['application/json']) # noqa: E501
|
|
1020
|
+
|
|
1021
|
+
# Authentication setting
|
|
1022
|
+
auth_settings = ['X-Authorization'] # noqa: E501
|
|
1023
|
+
|
|
1024
|
+
return self.api_client.call_api(
|
|
1025
|
+
'/api/entityGroup/{ownerType}/{ownerId}/{groupType}/{groupName}', 'GET',
|
|
1026
|
+
path_params,
|
|
1027
|
+
query_params,
|
|
1028
|
+
header_params,
|
|
1029
|
+
body=body_params,
|
|
1030
|
+
post_params=form_params,
|
|
1031
|
+
files=local_var_files,
|
|
1032
|
+
response_type='EntityGroupInfo', # noqa: E501
|
|
1033
|
+
auth_settings=auth_settings,
|
|
1034
|
+
async_req=params.get('async_req'),
|
|
1035
|
+
_return_http_data_only=params.get('_return_http_data_only'),
|
|
1036
|
+
_preload_content=params.get('_preload_content', True),
|
|
1037
|
+
_request_timeout=params.get('_request_timeout'),
|
|
1038
|
+
collection_formats=collection_formats)
|
|
1039
|
+
|
|
1040
|
+
def get_entity_group_entity_info_by_id_using_get(self, entity_group_id, **kwargs): # noqa: E501
|
|
1041
|
+
"""Get Entity Group Entity Info (getEntityGroupEntityInfoById) # noqa: E501
|
|
1042
|
+
|
|
1043
|
+
Fetch the Entity Group Entity Info object based on the provided Entity Group Id. Entity Info is a lightweight object that contains only id and name of the entity group. Entity group name is unique in the scope of owner and entity type. For example, you can't create two tenant device groups called 'Water meters'. However, you may create device and asset group with the same name. And also you may create groups with the same name for two different customers of the same tenant. Available for users with 'TENANT_ADMIN' or 'CUSTOMER_USER' authority. Security check is performed to verify that the user has 'READ' permission for specified group. # noqa: E501
|
|
1044
|
+
This method makes a synchronous HTTP request by default. To make an
|
|
1045
|
+
asynchronous HTTP request, please pass async_req=True
|
|
1046
|
+
>>> thread = api.get_entity_group_entity_info_by_id_using_get(entity_group_id, async_req=True)
|
|
1047
|
+
>>> result = thread.get()
|
|
1048
|
+
|
|
1049
|
+
:param async_req bool
|
|
1050
|
+
:param str entity_group_id: A string value representing the Entity Group Id. For example, '784f394c-42b6-435a-983c-b7beff2784f9' (required)
|
|
1051
|
+
:return: EntityInfo
|
|
1052
|
+
If the method is called asynchronously,
|
|
1053
|
+
returns the request thread.
|
|
1054
|
+
"""
|
|
1055
|
+
kwargs['_return_http_data_only'] = True
|
|
1056
|
+
if kwargs.get('async_req'):
|
|
1057
|
+
return self.get_entity_group_entity_info_by_id_using_get_with_http_info(entity_group_id, **kwargs) # noqa: E501
|
|
1058
|
+
else:
|
|
1059
|
+
(data) = self.get_entity_group_entity_info_by_id_using_get_with_http_info(entity_group_id, **kwargs) # noqa: E501
|
|
1060
|
+
return data
|
|
1061
|
+
|
|
1062
|
+
def get_entity_group_entity_info_by_id_using_get_with_http_info(self, entity_group_id, **kwargs): # noqa: E501
|
|
1063
|
+
"""Get Entity Group Entity Info (getEntityGroupEntityInfoById) # noqa: E501
|
|
1064
|
+
|
|
1065
|
+
Fetch the Entity Group Entity Info object based on the provided Entity Group Id. Entity Info is a lightweight object that contains only id and name of the entity group. Entity group name is unique in the scope of owner and entity type. For example, you can't create two tenant device groups called 'Water meters'. However, you may create device and asset group with the same name. And also you may create groups with the same name for two different customers of the same tenant. Available for users with 'TENANT_ADMIN' or 'CUSTOMER_USER' authority. Security check is performed to verify that the user has 'READ' permission for specified group. # noqa: E501
|
|
1066
|
+
This method makes a synchronous HTTP request by default. To make an
|
|
1067
|
+
asynchronous HTTP request, please pass async_req=True
|
|
1068
|
+
>>> thread = api.get_entity_group_entity_info_by_id_using_get_with_http_info(entity_group_id, async_req=True)
|
|
1069
|
+
>>> result = thread.get()
|
|
1070
|
+
|
|
1071
|
+
:param async_req bool
|
|
1072
|
+
:param str entity_group_id: A string value representing the Entity Group Id. For example, '784f394c-42b6-435a-983c-b7beff2784f9' (required)
|
|
1073
|
+
:return: EntityInfo
|
|
1074
|
+
If the method is called asynchronously,
|
|
1075
|
+
returns the request thread.
|
|
1076
|
+
"""
|
|
1077
|
+
|
|
1078
|
+
all_params = ['entity_group_id'] # noqa: E501
|
|
1079
|
+
all_params.append('async_req')
|
|
1080
|
+
all_params.append('_return_http_data_only')
|
|
1081
|
+
all_params.append('_preload_content')
|
|
1082
|
+
all_params.append('_request_timeout')
|
|
1083
|
+
|
|
1084
|
+
params = locals()
|
|
1085
|
+
for key, val in six.iteritems(params['kwargs']):
|
|
1086
|
+
if key not in all_params:
|
|
1087
|
+
raise TypeError(
|
|
1088
|
+
"Got an unexpected keyword argument '%s'"
|
|
1089
|
+
" to method get_entity_group_entity_info_by_id_using_get" % key
|
|
1090
|
+
)
|
|
1091
|
+
params[key] = val
|
|
1092
|
+
del params['kwargs']
|
|
1093
|
+
# verify the required parameter 'entity_group_id' is set
|
|
1094
|
+
if ('entity_group_id' not in params or
|
|
1095
|
+
params['entity_group_id'] is None):
|
|
1096
|
+
raise ValueError("Missing the required parameter `entity_group_id` when calling `get_entity_group_entity_info_by_id_using_get`") # noqa: E501
|
|
1097
|
+
|
|
1098
|
+
collection_formats = {}
|
|
1099
|
+
|
|
1100
|
+
path_params = {}
|
|
1101
|
+
if 'entity_group_id' in params:
|
|
1102
|
+
path_params['entityGroupId'] = params['entity_group_id'] # noqa: E501
|
|
1103
|
+
|
|
1104
|
+
query_params = []
|
|
1105
|
+
|
|
1106
|
+
header_params = {}
|
|
1107
|
+
|
|
1108
|
+
form_params = []
|
|
1109
|
+
local_var_files = {}
|
|
1110
|
+
|
|
1111
|
+
body_params = None
|
|
1112
|
+
# HTTP header `Accept`
|
|
1113
|
+
header_params['Accept'] = self.api_client.select_header_accept(
|
|
1114
|
+
['application/json']) # noqa: E501
|
|
1115
|
+
|
|
1116
|
+
# Authentication setting
|
|
1117
|
+
auth_settings = ['X-Authorization'] # noqa: E501
|
|
1118
|
+
|
|
1119
|
+
return self.api_client.call_api(
|
|
1120
|
+
'/api/entityGroupInfo/{entityGroupId}', 'GET',
|
|
1121
|
+
path_params,
|
|
1122
|
+
query_params,
|
|
1123
|
+
header_params,
|
|
1124
|
+
body=body_params,
|
|
1125
|
+
post_params=form_params,
|
|
1126
|
+
files=local_var_files,
|
|
1127
|
+
response_type='EntityInfo', # noqa: E501
|
|
1128
|
+
auth_settings=auth_settings,
|
|
1129
|
+
async_req=params.get('async_req'),
|
|
1130
|
+
_return_http_data_only=params.get('_return_http_data_only'),
|
|
1131
|
+
_preload_content=params.get('_preload_content', True),
|
|
1132
|
+
_request_timeout=params.get('_request_timeout'),
|
|
1133
|
+
collection_formats=collection_formats)
|
|
1134
|
+
|
|
1135
|
+
def get_entity_group_entity_infos_by_ids_using_get(self, entity_group_ids, **kwargs): # noqa: E501
|
|
1136
|
+
"""Get Entity Group Entity Infos by Ids (getEntityGroupEntityInfosByIds) # noqa: E501
|
|
1137
|
+
|
|
1138
|
+
Fetch the list of Entity Group Entity Info objects based on the provided entity group ids list. Entity Info is a lightweight object that contains only id and name of the entity group. Available for users with 'TENANT_ADMIN' or 'CUSTOMER_USER' authority. Security check is performed to verify that the user has 'READ' permission for specified group. # noqa: E501
|
|
1139
|
+
This method makes a synchronous HTTP request by default. To make an
|
|
1140
|
+
asynchronous HTTP request, please pass async_req=True
|
|
1141
|
+
>>> thread = api.get_entity_group_entity_infos_by_ids_using_get(entity_group_ids, async_req=True)
|
|
1142
|
+
>>> result = thread.get()
|
|
1143
|
+
|
|
1144
|
+
:param async_req bool
|
|
1145
|
+
:param str entity_group_ids: A list of group ids, separated by comma ',' (required)
|
|
1146
|
+
:return: list[EntityInfo]
|
|
1147
|
+
If the method is called asynchronously,
|
|
1148
|
+
returns the request thread.
|
|
1149
|
+
"""
|
|
1150
|
+
kwargs['_return_http_data_only'] = True
|
|
1151
|
+
if kwargs.get('async_req'):
|
|
1152
|
+
return self.get_entity_group_entity_infos_by_ids_using_get_with_http_info(entity_group_ids, **kwargs) # noqa: E501
|
|
1153
|
+
else:
|
|
1154
|
+
(data) = self.get_entity_group_entity_infos_by_ids_using_get_with_http_info(entity_group_ids, **kwargs) # noqa: E501
|
|
1155
|
+
return data
|
|
1156
|
+
|
|
1157
|
+
def get_entity_group_entity_infos_by_ids_using_get_with_http_info(self, entity_group_ids, **kwargs): # noqa: E501
|
|
1158
|
+
"""Get Entity Group Entity Infos by Ids (getEntityGroupEntityInfosByIds) # noqa: E501
|
|
1159
|
+
|
|
1160
|
+
Fetch the list of Entity Group Entity Info objects based on the provided entity group ids list. Entity Info is a lightweight object that contains only id and name of the entity group. Available for users with 'TENANT_ADMIN' or 'CUSTOMER_USER' authority. Security check is performed to verify that the user has 'READ' permission for specified group. # noqa: E501
|
|
1161
|
+
This method makes a synchronous HTTP request by default. To make an
|
|
1162
|
+
asynchronous HTTP request, please pass async_req=True
|
|
1163
|
+
>>> thread = api.get_entity_group_entity_infos_by_ids_using_get_with_http_info(entity_group_ids, async_req=True)
|
|
1164
|
+
>>> result = thread.get()
|
|
1165
|
+
|
|
1166
|
+
:param async_req bool
|
|
1167
|
+
:param str entity_group_ids: A list of group ids, separated by comma ',' (required)
|
|
1168
|
+
:return: list[EntityInfo]
|
|
1169
|
+
If the method is called asynchronously,
|
|
1170
|
+
returns the request thread.
|
|
1171
|
+
"""
|
|
1172
|
+
|
|
1173
|
+
all_params = ['entity_group_ids'] # noqa: E501
|
|
1174
|
+
all_params.append('async_req')
|
|
1175
|
+
all_params.append('_return_http_data_only')
|
|
1176
|
+
all_params.append('_preload_content')
|
|
1177
|
+
all_params.append('_request_timeout')
|
|
1178
|
+
|
|
1179
|
+
params = locals()
|
|
1180
|
+
for key, val in six.iteritems(params['kwargs']):
|
|
1181
|
+
if key not in all_params:
|
|
1182
|
+
raise TypeError(
|
|
1183
|
+
"Got an unexpected keyword argument '%s'"
|
|
1184
|
+
" to method get_entity_group_entity_infos_by_ids_using_get" % key
|
|
1185
|
+
)
|
|
1186
|
+
params[key] = val
|
|
1187
|
+
del params['kwargs']
|
|
1188
|
+
# verify the required parameter 'entity_group_ids' is set
|
|
1189
|
+
if ('entity_group_ids' not in params or
|
|
1190
|
+
params['entity_group_ids'] is None):
|
|
1191
|
+
raise ValueError("Missing the required parameter `entity_group_ids` when calling `get_entity_group_entity_infos_by_ids_using_get`") # noqa: E501
|
|
1192
|
+
|
|
1193
|
+
collection_formats = {}
|
|
1194
|
+
|
|
1195
|
+
path_params = {}
|
|
1196
|
+
|
|
1197
|
+
query_params = []
|
|
1198
|
+
if 'entity_group_ids' in params:
|
|
1199
|
+
query_params.append(('entityGroupIds', params['entity_group_ids'])) # noqa: E501
|
|
1200
|
+
|
|
1201
|
+
header_params = {}
|
|
1202
|
+
|
|
1203
|
+
form_params = []
|
|
1204
|
+
local_var_files = {}
|
|
1205
|
+
|
|
1206
|
+
body_params = None
|
|
1207
|
+
# HTTP header `Accept`
|
|
1208
|
+
header_params['Accept'] = self.api_client.select_header_accept(
|
|
1209
|
+
['application/json']) # noqa: E501
|
|
1210
|
+
|
|
1211
|
+
# Authentication setting
|
|
1212
|
+
auth_settings = ['X-Authorization'] # noqa: E501
|
|
1213
|
+
|
|
1214
|
+
return self.api_client.call_api(
|
|
1215
|
+
'/api/entityGroupInfos{?entityGroupIds}', 'GET',
|
|
1216
|
+
path_params,
|
|
1217
|
+
query_params,
|
|
1218
|
+
header_params,
|
|
1219
|
+
body=body_params,
|
|
1220
|
+
post_params=form_params,
|
|
1221
|
+
files=local_var_files,
|
|
1222
|
+
response_type='list[EntityInfo]', # noqa: E501
|
|
1223
|
+
auth_settings=auth_settings,
|
|
1224
|
+
async_req=params.get('async_req'),
|
|
1225
|
+
_return_http_data_only=params.get('_return_http_data_only'),
|
|
1226
|
+
_preload_content=params.get('_preload_content', True),
|
|
1227
|
+
_request_timeout=params.get('_request_timeout'),
|
|
1228
|
+
collection_formats=collection_formats)
|
|
1229
|
+
|
|
1230
|
+
def get_entity_group_entity_infos_by_owner_and_type_and_page_link_using_get(self, owner_type, owner_id, group_type, page_size, page, **kwargs): # noqa: E501
|
|
1231
|
+
"""Get Entity Group Entity Infos by owner and entity type and page link (getEntityGroupEntityInfosByOwnerAndTypeAndPageLink) # noqa: E501
|
|
1232
|
+
|
|
1233
|
+
Returns a page of Entity Group Entity Info objects based on the provided Owner Id and Entity Type and Page Link. Entity Info is a lightweight object that contains only id and name of the entity group. You can specify parameters to filter the results. The result is wrapped with PageData object that allows you to iterate over result set using pagination. See the 'Model' tab of the Response Class for more details. Available for users with 'TENANT_ADMIN' or 'CUSTOMER_USER' authority. Security check is performed to verify that the user has 'READ' permission for specified group. # noqa: E501
|
|
1234
|
+
This method makes a synchronous HTTP request by default. To make an
|
|
1235
|
+
asynchronous HTTP request, please pass async_req=True
|
|
1236
|
+
>>> thread = api.get_entity_group_entity_infos_by_owner_and_type_and_page_link_using_get(owner_type, owner_id, group_type, page_size, page, async_req=True)
|
|
1237
|
+
>>> result = thread.get()
|
|
1238
|
+
|
|
1239
|
+
:param async_req bool
|
|
1240
|
+
:param str owner_type: Tenant or Customer (required)
|
|
1241
|
+
:param str owner_id: A string value representing the Tenant or Customer id (required)
|
|
1242
|
+
:param str group_type: Entity Group type (required)
|
|
1243
|
+
:param int page_size: Maximum amount of entities in a one page (required)
|
|
1244
|
+
:param int page: Sequence number of page starting from 0 (required)
|
|
1245
|
+
:param str text_search: The case insensitive 'startsWith' filter based on the entity group name.
|
|
1246
|
+
:param str sort_property: Property of entity to sort by
|
|
1247
|
+
:param str sort_order: Sort order. ASC (ASCENDING) or DESC (DESCENDING)
|
|
1248
|
+
:return: PageDataEntityInfo
|
|
1249
|
+
If the method is called asynchronously,
|
|
1250
|
+
returns the request thread.
|
|
1251
|
+
"""
|
|
1252
|
+
kwargs['_return_http_data_only'] = True
|
|
1253
|
+
if kwargs.get('async_req'):
|
|
1254
|
+
return self.get_entity_group_entity_infos_by_owner_and_type_and_page_link_using_get_with_http_info(owner_type, owner_id, group_type, page_size, page, **kwargs) # noqa: E501
|
|
1255
|
+
else:
|
|
1256
|
+
(data) = self.get_entity_group_entity_infos_by_owner_and_type_and_page_link_using_get_with_http_info(owner_type, owner_id, group_type, page_size, page, **kwargs) # noqa: E501
|
|
1257
|
+
return data
|
|
1258
|
+
|
|
1259
|
+
def get_entity_group_entity_infos_by_owner_and_type_and_page_link_using_get_with_http_info(self, owner_type, owner_id, group_type, page_size, page, **kwargs): # noqa: E501
|
|
1260
|
+
"""Get Entity Group Entity Infos by owner and entity type and page link (getEntityGroupEntityInfosByOwnerAndTypeAndPageLink) # noqa: E501
|
|
1261
|
+
|
|
1262
|
+
Returns a page of Entity Group Entity Info objects based on the provided Owner Id and Entity Type and Page Link. Entity Info is a lightweight object that contains only id and name of the entity group. You can specify parameters to filter the results. The result is wrapped with PageData object that allows you to iterate over result set using pagination. See the 'Model' tab of the Response Class for more details. Available for users with 'TENANT_ADMIN' or 'CUSTOMER_USER' authority. Security check is performed to verify that the user has 'READ' permission for specified group. # noqa: E501
|
|
1263
|
+
This method makes a synchronous HTTP request by default. To make an
|
|
1264
|
+
asynchronous HTTP request, please pass async_req=True
|
|
1265
|
+
>>> thread = api.get_entity_group_entity_infos_by_owner_and_type_and_page_link_using_get_with_http_info(owner_type, owner_id, group_type, page_size, page, async_req=True)
|
|
1266
|
+
>>> result = thread.get()
|
|
1267
|
+
|
|
1268
|
+
:param async_req bool
|
|
1269
|
+
:param str owner_type: Tenant or Customer (required)
|
|
1270
|
+
:param str owner_id: A string value representing the Tenant or Customer id (required)
|
|
1271
|
+
:param str group_type: Entity Group type (required)
|
|
1272
|
+
:param int page_size: Maximum amount of entities in a one page (required)
|
|
1273
|
+
:param int page: Sequence number of page starting from 0 (required)
|
|
1274
|
+
:param str text_search: The case insensitive 'startsWith' filter based on the entity group name.
|
|
1275
|
+
:param str sort_property: Property of entity to sort by
|
|
1276
|
+
:param str sort_order: Sort order. ASC (ASCENDING) or DESC (DESCENDING)
|
|
1277
|
+
:return: PageDataEntityInfo
|
|
1278
|
+
If the method is called asynchronously,
|
|
1279
|
+
returns the request thread.
|
|
1280
|
+
"""
|
|
1281
|
+
|
|
1282
|
+
all_params = ['owner_type', 'owner_id', 'group_type', 'page_size', 'page', 'text_search', 'sort_property', 'sort_order'] # noqa: E501
|
|
1283
|
+
all_params.append('async_req')
|
|
1284
|
+
all_params.append('_return_http_data_only')
|
|
1285
|
+
all_params.append('_preload_content')
|
|
1286
|
+
all_params.append('_request_timeout')
|
|
1287
|
+
|
|
1288
|
+
params = locals()
|
|
1289
|
+
for key, val in six.iteritems(params['kwargs']):
|
|
1290
|
+
if key not in all_params:
|
|
1291
|
+
raise TypeError(
|
|
1292
|
+
"Got an unexpected keyword argument '%s'"
|
|
1293
|
+
" to method get_entity_group_entity_infos_by_owner_and_type_and_page_link_using_get" % key
|
|
1294
|
+
)
|
|
1295
|
+
params[key] = val
|
|
1296
|
+
del params['kwargs']
|
|
1297
|
+
# verify the required parameter 'owner_type' is set
|
|
1298
|
+
if ('owner_type' not in params or
|
|
1299
|
+
params['owner_type'] is None):
|
|
1300
|
+
raise ValueError("Missing the required parameter `owner_type` when calling `get_entity_group_entity_infos_by_owner_and_type_and_page_link_using_get`") # noqa: E501
|
|
1301
|
+
# verify the required parameter 'owner_id' is set
|
|
1302
|
+
if ('owner_id' not in params or
|
|
1303
|
+
params['owner_id'] is None):
|
|
1304
|
+
raise ValueError("Missing the required parameter `owner_id` when calling `get_entity_group_entity_infos_by_owner_and_type_and_page_link_using_get`") # noqa: E501
|
|
1305
|
+
# verify the required parameter 'group_type' is set
|
|
1306
|
+
if ('group_type' not in params or
|
|
1307
|
+
params['group_type'] is None):
|
|
1308
|
+
raise ValueError("Missing the required parameter `group_type` when calling `get_entity_group_entity_infos_by_owner_and_type_and_page_link_using_get`") # noqa: E501
|
|
1309
|
+
# verify the required parameter 'page_size' is set
|
|
1310
|
+
if ('page_size' not in params or
|
|
1311
|
+
params['page_size'] is None):
|
|
1312
|
+
raise ValueError("Missing the required parameter `page_size` when calling `get_entity_group_entity_infos_by_owner_and_type_and_page_link_using_get`") # noqa: E501
|
|
1313
|
+
# verify the required parameter 'page' is set
|
|
1314
|
+
if ('page' not in params or
|
|
1315
|
+
params['page'] is None):
|
|
1316
|
+
raise ValueError("Missing the required parameter `page` when calling `get_entity_group_entity_infos_by_owner_and_type_and_page_link_using_get`") # noqa: E501
|
|
1317
|
+
|
|
1318
|
+
collection_formats = {}
|
|
1319
|
+
|
|
1320
|
+
path_params = {}
|
|
1321
|
+
if 'owner_type' in params:
|
|
1322
|
+
path_params['ownerType'] = params['owner_type'] # noqa: E501
|
|
1323
|
+
if 'owner_id' in params:
|
|
1324
|
+
path_params['ownerId'] = params['owner_id'] # noqa: E501
|
|
1325
|
+
if 'group_type' in params:
|
|
1326
|
+
path_params['groupType'] = params['group_type'] # noqa: E501
|
|
1327
|
+
|
|
1328
|
+
query_params = []
|
|
1329
|
+
if 'page_size' in params:
|
|
1330
|
+
query_params.append(('pageSize', params['page_size'])) # noqa: E501
|
|
1331
|
+
if 'page' in params:
|
|
1332
|
+
query_params.append(('page', params['page'])) # noqa: E501
|
|
1333
|
+
if 'text_search' in params:
|
|
1334
|
+
query_params.append(('textSearch', params['text_search'])) # noqa: E501
|
|
1335
|
+
if 'sort_property' in params:
|
|
1336
|
+
query_params.append(('sortProperty', params['sort_property'])) # noqa: E501
|
|
1337
|
+
if 'sort_order' in params:
|
|
1338
|
+
query_params.append(('sortOrder', params['sort_order'])) # noqa: E501
|
|
1339
|
+
|
|
1340
|
+
header_params = {}
|
|
1341
|
+
|
|
1342
|
+
form_params = []
|
|
1343
|
+
local_var_files = {}
|
|
1344
|
+
|
|
1345
|
+
body_params = None
|
|
1346
|
+
# HTTP header `Accept`
|
|
1347
|
+
header_params['Accept'] = self.api_client.select_header_accept(
|
|
1348
|
+
['application/json']) # noqa: E501
|
|
1349
|
+
|
|
1350
|
+
# Authentication setting
|
|
1351
|
+
auth_settings = ['X-Authorization'] # noqa: E501
|
|
1352
|
+
|
|
1353
|
+
return self.api_client.call_api(
|
|
1354
|
+
'/api/entityGroupInfos/{ownerType}/{ownerId}/{groupType}{?page,pageSize,sortOrder,sortProperty,textSearch}', 'GET',
|
|
1355
|
+
path_params,
|
|
1356
|
+
query_params,
|
|
1357
|
+
header_params,
|
|
1358
|
+
body=body_params,
|
|
1359
|
+
post_params=form_params,
|
|
1360
|
+
files=local_var_files,
|
|
1361
|
+
response_type='PageDataEntityInfo', # noqa: E501
|
|
1362
|
+
auth_settings=auth_settings,
|
|
1363
|
+
async_req=params.get('async_req'),
|
|
1364
|
+
_return_http_data_only=params.get('_return_http_data_only'),
|
|
1365
|
+
_preload_content=params.get('_preload_content', True),
|
|
1366
|
+
_request_timeout=params.get('_request_timeout'),
|
|
1367
|
+
collection_formats=collection_formats)
|
|
1368
|
+
|
|
1369
|
+
def get_entity_group_entity_infos_by_type_and_page_link_using_get(self, group_type, page_size, page, **kwargs): # noqa: E501
|
|
1370
|
+
"""Get Entity Group Entity Infos by entity type and page link (getEntityGroupEntityInfosByTypeAndPageLink) # noqa: E501
|
|
1371
|
+
|
|
1372
|
+
Returns a page of Entity Group Entity Info objects based on the provided Entity Type and Page Link. Entity Info is a lightweight object that contains only id and name of the entity group. You can specify parameters to filter the results. The result is wrapped with PageData object that allows you to iterate over result set using pagination. See the 'Model' tab of the Response Class for more details. Available for users with 'TENANT_ADMIN' or 'CUSTOMER_USER' authority. Security check is performed to verify that the user has 'READ' permission for specified group. # noqa: E501
|
|
1373
|
+
This method makes a synchronous HTTP request by default. To make an
|
|
1374
|
+
asynchronous HTTP request, please pass async_req=True
|
|
1375
|
+
>>> thread = api.get_entity_group_entity_infos_by_type_and_page_link_using_get(group_type, page_size, page, async_req=True)
|
|
1376
|
+
>>> result = thread.get()
|
|
1377
|
+
|
|
1378
|
+
:param async_req bool
|
|
1379
|
+
:param str group_type: Entity Group type (required)
|
|
1380
|
+
:param int page_size: Maximum amount of entities in a one page (required)
|
|
1381
|
+
:param int page: Sequence number of page starting from 0 (required)
|
|
1382
|
+
:param bool include_shared: Whether to include shared entity groups.
|
|
1383
|
+
:param str text_search: The case insensitive 'startsWith' filter based on the entity group name.
|
|
1384
|
+
:param str sort_property: Property of entity to sort by
|
|
1385
|
+
:param str sort_order: Sort order. ASC (ASCENDING) or DESC (DESCENDING)
|
|
1386
|
+
:return: PageDataEntityInfo
|
|
1387
|
+
If the method is called asynchronously,
|
|
1388
|
+
returns the request thread.
|
|
1389
|
+
"""
|
|
1390
|
+
kwargs['_return_http_data_only'] = True
|
|
1391
|
+
if kwargs.get('async_req'):
|
|
1392
|
+
return self.get_entity_group_entity_infos_by_type_and_page_link_using_get_with_http_info(group_type, page_size, page, **kwargs) # noqa: E501
|
|
1393
|
+
else:
|
|
1394
|
+
(data) = self.get_entity_group_entity_infos_by_type_and_page_link_using_get_with_http_info(group_type, page_size, page, **kwargs) # noqa: E501
|
|
1395
|
+
return data
|
|
1396
|
+
|
|
1397
|
+
def get_entity_group_entity_infos_by_type_and_page_link_using_get_with_http_info(self, group_type, page_size, page, **kwargs): # noqa: E501
|
|
1398
|
+
"""Get Entity Group Entity Infos by entity type and page link (getEntityGroupEntityInfosByTypeAndPageLink) # noqa: E501
|
|
1399
|
+
|
|
1400
|
+
Returns a page of Entity Group Entity Info objects based on the provided Entity Type and Page Link. Entity Info is a lightweight object that contains only id and name of the entity group. You can specify parameters to filter the results. The result is wrapped with PageData object that allows you to iterate over result set using pagination. See the 'Model' tab of the Response Class for more details. Available for users with 'TENANT_ADMIN' or 'CUSTOMER_USER' authority. Security check is performed to verify that the user has 'READ' permission for specified group. # noqa: E501
|
|
1401
|
+
This method makes a synchronous HTTP request by default. To make an
|
|
1402
|
+
asynchronous HTTP request, please pass async_req=True
|
|
1403
|
+
>>> thread = api.get_entity_group_entity_infos_by_type_and_page_link_using_get_with_http_info(group_type, page_size, page, async_req=True)
|
|
1404
|
+
>>> result = thread.get()
|
|
1405
|
+
|
|
1406
|
+
:param async_req bool
|
|
1407
|
+
:param str group_type: Entity Group type (required)
|
|
1408
|
+
:param int page_size: Maximum amount of entities in a one page (required)
|
|
1409
|
+
:param int page: Sequence number of page starting from 0 (required)
|
|
1410
|
+
:param bool include_shared: Whether to include shared entity groups.
|
|
1411
|
+
:param str text_search: The case insensitive 'startsWith' filter based on the entity group name.
|
|
1412
|
+
:param str sort_property: Property of entity to sort by
|
|
1413
|
+
:param str sort_order: Sort order. ASC (ASCENDING) or DESC (DESCENDING)
|
|
1414
|
+
:return: PageDataEntityInfo
|
|
1415
|
+
If the method is called asynchronously,
|
|
1416
|
+
returns the request thread.
|
|
1417
|
+
"""
|
|
1418
|
+
|
|
1419
|
+
all_params = ['group_type', 'page_size', 'page', 'include_shared', 'text_search', 'sort_property', 'sort_order'] # noqa: E501
|
|
1420
|
+
all_params.append('async_req')
|
|
1421
|
+
all_params.append('_return_http_data_only')
|
|
1422
|
+
all_params.append('_preload_content')
|
|
1423
|
+
all_params.append('_request_timeout')
|
|
1424
|
+
|
|
1425
|
+
params = locals()
|
|
1426
|
+
for key, val in six.iteritems(params['kwargs']):
|
|
1427
|
+
if key not in all_params:
|
|
1428
|
+
raise TypeError(
|
|
1429
|
+
"Got an unexpected keyword argument '%s'"
|
|
1430
|
+
" to method get_entity_group_entity_infos_by_type_and_page_link_using_get" % key
|
|
1431
|
+
)
|
|
1432
|
+
params[key] = val
|
|
1433
|
+
del params['kwargs']
|
|
1434
|
+
# verify the required parameter 'group_type' is set
|
|
1435
|
+
if ('group_type' not in params or
|
|
1436
|
+
params['group_type'] is None):
|
|
1437
|
+
raise ValueError("Missing the required parameter `group_type` when calling `get_entity_group_entity_infos_by_type_and_page_link_using_get`") # noqa: E501
|
|
1438
|
+
# verify the required parameter 'page_size' is set
|
|
1439
|
+
if ('page_size' not in params or
|
|
1440
|
+
params['page_size'] is None):
|
|
1441
|
+
raise ValueError("Missing the required parameter `page_size` when calling `get_entity_group_entity_infos_by_type_and_page_link_using_get`") # noqa: E501
|
|
1442
|
+
# verify the required parameter 'page' is set
|
|
1443
|
+
if ('page' not in params or
|
|
1444
|
+
params['page'] is None):
|
|
1445
|
+
raise ValueError("Missing the required parameter `page` when calling `get_entity_group_entity_infos_by_type_and_page_link_using_get`") # noqa: E501
|
|
1446
|
+
|
|
1447
|
+
collection_formats = {}
|
|
1448
|
+
|
|
1449
|
+
path_params = {}
|
|
1450
|
+
if 'group_type' in params:
|
|
1451
|
+
path_params['groupType'] = params['group_type'] # noqa: E501
|
|
1452
|
+
|
|
1453
|
+
query_params = []
|
|
1454
|
+
if 'include_shared' in params:
|
|
1455
|
+
query_params.append(('includeShared', params['include_shared'])) # noqa: E501
|
|
1456
|
+
if 'page_size' in params:
|
|
1457
|
+
query_params.append(('pageSize', params['page_size'])) # noqa: E501
|
|
1458
|
+
if 'page' in params:
|
|
1459
|
+
query_params.append(('page', params['page'])) # noqa: E501
|
|
1460
|
+
if 'text_search' in params:
|
|
1461
|
+
query_params.append(('textSearch', params['text_search'])) # noqa: E501
|
|
1462
|
+
if 'sort_property' in params:
|
|
1463
|
+
query_params.append(('sortProperty', params['sort_property'])) # noqa: E501
|
|
1464
|
+
if 'sort_order' in params:
|
|
1465
|
+
query_params.append(('sortOrder', params['sort_order'])) # noqa: E501
|
|
1466
|
+
|
|
1467
|
+
header_params = {}
|
|
1468
|
+
|
|
1469
|
+
form_params = []
|
|
1470
|
+
local_var_files = {}
|
|
1471
|
+
|
|
1472
|
+
body_params = None
|
|
1473
|
+
# HTTP header `Accept`
|
|
1474
|
+
header_params['Accept'] = self.api_client.select_header_accept(
|
|
1475
|
+
['application/json']) # noqa: E501
|
|
1476
|
+
|
|
1477
|
+
# Authentication setting
|
|
1478
|
+
auth_settings = ['X-Authorization'] # noqa: E501
|
|
1479
|
+
|
|
1480
|
+
return self.api_client.call_api(
|
|
1481
|
+
'/api/entityGroupInfos/{groupType}{?includeShared,page,pageSize,sortOrder,sortProperty,textSearch}', 'GET',
|
|
1482
|
+
path_params,
|
|
1483
|
+
query_params,
|
|
1484
|
+
header_params,
|
|
1485
|
+
body=body_params,
|
|
1486
|
+
post_params=form_params,
|
|
1487
|
+
files=local_var_files,
|
|
1488
|
+
response_type='PageDataEntityInfo', # noqa: E501
|
|
1489
|
+
auth_settings=auth_settings,
|
|
1490
|
+
async_req=params.get('async_req'),
|
|
1491
|
+
_return_http_data_only=params.get('_return_http_data_only'),
|
|
1492
|
+
_preload_content=params.get('_preload_content', True),
|
|
1493
|
+
_request_timeout=params.get('_request_timeout'),
|
|
1494
|
+
collection_formats=collection_formats)
|
|
1495
|
+
|
|
1496
|
+
def get_entity_group_entity_infos_hierarchy_by_owner_and_type_and_page_link_using_get(self, owner_type, owner_id, group_type, page_size, page, **kwargs): # noqa: E501
|
|
1497
|
+
"""Get Entity Group Entity Infos for all owners starting from specified than ending with owner of current user (getEntityGroupEntityInfosHierarchyByOwnerAndTypeAndPageLink) # noqa: E501
|
|
1498
|
+
|
|
1499
|
+
Returns a page of Entity Group Entity Info objects based on the provided Owner Id and Entity Type and Page Link. Entity Info is a lightweight object that contains only id and name of the entity group. You can specify parameters to filter the results. The result is wrapped with PageData object that allows you to iterate over result set using pagination. See the 'Model' tab of the Response Class for more details. Available for users with 'TENANT_ADMIN' or 'CUSTOMER_USER' authority. Security check is performed to verify that the user has 'READ' permission for specified group. # noqa: E501
|
|
1500
|
+
This method makes a synchronous HTTP request by default. To make an
|
|
1501
|
+
asynchronous HTTP request, please pass async_req=True
|
|
1502
|
+
>>> thread = api.get_entity_group_entity_infos_hierarchy_by_owner_and_type_and_page_link_using_get(owner_type, owner_id, group_type, page_size, page, async_req=True)
|
|
1503
|
+
>>> result = thread.get()
|
|
1504
|
+
|
|
1505
|
+
:param async_req bool
|
|
1506
|
+
:param str owner_type: Tenant or Customer (required)
|
|
1507
|
+
:param str owner_id: A string value representing the Tenant or Customer id (required)
|
|
1508
|
+
:param str group_type: Entity Group type (required)
|
|
1509
|
+
:param int page_size: Maximum amount of entities in a one page (required)
|
|
1510
|
+
:param int page: Sequence number of page starting from 0 (required)
|
|
1511
|
+
:param str text_search: The case insensitive 'startsWith' filter based on the entity group name.
|
|
1512
|
+
:param str sort_property: Property of entity to sort by
|
|
1513
|
+
:param str sort_order: Sort order. ASC (ASCENDING) or DESC (DESCENDING)
|
|
1514
|
+
:return: PageDataEntityInfo
|
|
1515
|
+
If the method is called asynchronously,
|
|
1516
|
+
returns the request thread.
|
|
1517
|
+
"""
|
|
1518
|
+
kwargs['_return_http_data_only'] = True
|
|
1519
|
+
if kwargs.get('async_req'):
|
|
1520
|
+
return self.get_entity_group_entity_infos_hierarchy_by_owner_and_type_and_page_link_using_get_with_http_info(owner_type, owner_id, group_type, page_size, page, **kwargs) # noqa: E501
|
|
1521
|
+
else:
|
|
1522
|
+
(data) = self.get_entity_group_entity_infos_hierarchy_by_owner_and_type_and_page_link_using_get_with_http_info(owner_type, owner_id, group_type, page_size, page, **kwargs) # noqa: E501
|
|
1523
|
+
return data
|
|
1524
|
+
|
|
1525
|
+
def get_entity_group_entity_infos_hierarchy_by_owner_and_type_and_page_link_using_get_with_http_info(self, owner_type, owner_id, group_type, page_size, page, **kwargs): # noqa: E501
|
|
1526
|
+
"""Get Entity Group Entity Infos for all owners starting from specified than ending with owner of current user (getEntityGroupEntityInfosHierarchyByOwnerAndTypeAndPageLink) # noqa: E501
|
|
1527
|
+
|
|
1528
|
+
Returns a page of Entity Group Entity Info objects based on the provided Owner Id and Entity Type and Page Link. Entity Info is a lightweight object that contains only id and name of the entity group. You can specify parameters to filter the results. The result is wrapped with PageData object that allows you to iterate over result set using pagination. See the 'Model' tab of the Response Class for more details. Available for users with 'TENANT_ADMIN' or 'CUSTOMER_USER' authority. Security check is performed to verify that the user has 'READ' permission for specified group. # noqa: E501
|
|
1529
|
+
This method makes a synchronous HTTP request by default. To make an
|
|
1530
|
+
asynchronous HTTP request, please pass async_req=True
|
|
1531
|
+
>>> thread = api.get_entity_group_entity_infos_hierarchy_by_owner_and_type_and_page_link_using_get_with_http_info(owner_type, owner_id, group_type, page_size, page, async_req=True)
|
|
1532
|
+
>>> result = thread.get()
|
|
1533
|
+
|
|
1534
|
+
:param async_req bool
|
|
1535
|
+
:param str owner_type: Tenant or Customer (required)
|
|
1536
|
+
:param str owner_id: A string value representing the Tenant or Customer id (required)
|
|
1537
|
+
:param str group_type: Entity Group type (required)
|
|
1538
|
+
:param int page_size: Maximum amount of entities in a one page (required)
|
|
1539
|
+
:param int page: Sequence number of page starting from 0 (required)
|
|
1540
|
+
:param str text_search: The case insensitive 'startsWith' filter based on the entity group name.
|
|
1541
|
+
:param str sort_property: Property of entity to sort by
|
|
1542
|
+
:param str sort_order: Sort order. ASC (ASCENDING) or DESC (DESCENDING)
|
|
1543
|
+
:return: PageDataEntityInfo
|
|
1544
|
+
If the method is called asynchronously,
|
|
1545
|
+
returns the request thread.
|
|
1546
|
+
"""
|
|
1547
|
+
|
|
1548
|
+
all_params = ['owner_type', 'owner_id', 'group_type', 'page_size', 'page', 'text_search', 'sort_property', 'sort_order'] # noqa: E501
|
|
1549
|
+
all_params.append('async_req')
|
|
1550
|
+
all_params.append('_return_http_data_only')
|
|
1551
|
+
all_params.append('_preload_content')
|
|
1552
|
+
all_params.append('_request_timeout')
|
|
1553
|
+
|
|
1554
|
+
params = locals()
|
|
1555
|
+
for key, val in six.iteritems(params['kwargs']):
|
|
1556
|
+
if key not in all_params:
|
|
1557
|
+
raise TypeError(
|
|
1558
|
+
"Got an unexpected keyword argument '%s'"
|
|
1559
|
+
" to method get_entity_group_entity_infos_hierarchy_by_owner_and_type_and_page_link_using_get" % key
|
|
1560
|
+
)
|
|
1561
|
+
params[key] = val
|
|
1562
|
+
del params['kwargs']
|
|
1563
|
+
# verify the required parameter 'owner_type' is set
|
|
1564
|
+
if ('owner_type' not in params or
|
|
1565
|
+
params['owner_type'] is None):
|
|
1566
|
+
raise ValueError("Missing the required parameter `owner_type` when calling `get_entity_group_entity_infos_hierarchy_by_owner_and_type_and_page_link_using_get`") # noqa: E501
|
|
1567
|
+
# verify the required parameter 'owner_id' is set
|
|
1568
|
+
if ('owner_id' not in params or
|
|
1569
|
+
params['owner_id'] is None):
|
|
1570
|
+
raise ValueError("Missing the required parameter `owner_id` when calling `get_entity_group_entity_infos_hierarchy_by_owner_and_type_and_page_link_using_get`") # noqa: E501
|
|
1571
|
+
# verify the required parameter 'group_type' is set
|
|
1572
|
+
if ('group_type' not in params or
|
|
1573
|
+
params['group_type'] is None):
|
|
1574
|
+
raise ValueError("Missing the required parameter `group_type` when calling `get_entity_group_entity_infos_hierarchy_by_owner_and_type_and_page_link_using_get`") # noqa: E501
|
|
1575
|
+
# verify the required parameter 'page_size' is set
|
|
1576
|
+
if ('page_size' not in params or
|
|
1577
|
+
params['page_size'] is None):
|
|
1578
|
+
raise ValueError("Missing the required parameter `page_size` when calling `get_entity_group_entity_infos_hierarchy_by_owner_and_type_and_page_link_using_get`") # noqa: E501
|
|
1579
|
+
# verify the required parameter 'page' is set
|
|
1580
|
+
if ('page' not in params or
|
|
1581
|
+
params['page'] is None):
|
|
1582
|
+
raise ValueError("Missing the required parameter `page` when calling `get_entity_group_entity_infos_hierarchy_by_owner_and_type_and_page_link_using_get`") # noqa: E501
|
|
1583
|
+
|
|
1584
|
+
collection_formats = {}
|
|
1585
|
+
|
|
1586
|
+
path_params = {}
|
|
1587
|
+
if 'owner_type' in params:
|
|
1588
|
+
path_params['ownerType'] = params['owner_type'] # noqa: E501
|
|
1589
|
+
if 'owner_id' in params:
|
|
1590
|
+
path_params['ownerId'] = params['owner_id'] # noqa: E501
|
|
1591
|
+
if 'group_type' in params:
|
|
1592
|
+
path_params['groupType'] = params['group_type'] # noqa: E501
|
|
1593
|
+
|
|
1594
|
+
query_params = []
|
|
1595
|
+
if 'page_size' in params:
|
|
1596
|
+
query_params.append(('pageSize', params['page_size'])) # noqa: E501
|
|
1597
|
+
if 'page' in params:
|
|
1598
|
+
query_params.append(('page', params['page'])) # noqa: E501
|
|
1599
|
+
if 'text_search' in params:
|
|
1600
|
+
query_params.append(('textSearch', params['text_search'])) # noqa: E501
|
|
1601
|
+
if 'sort_property' in params:
|
|
1602
|
+
query_params.append(('sortProperty', params['sort_property'])) # noqa: E501
|
|
1603
|
+
if 'sort_order' in params:
|
|
1604
|
+
query_params.append(('sortOrder', params['sort_order'])) # noqa: E501
|
|
1605
|
+
|
|
1606
|
+
header_params = {}
|
|
1607
|
+
|
|
1608
|
+
form_params = []
|
|
1609
|
+
local_var_files = {}
|
|
1610
|
+
|
|
1611
|
+
body_params = None
|
|
1612
|
+
# HTTP header `Accept`
|
|
1613
|
+
header_params['Accept'] = self.api_client.select_header_accept(
|
|
1614
|
+
['application/json']) # noqa: E501
|
|
1615
|
+
|
|
1616
|
+
# Authentication setting
|
|
1617
|
+
auth_settings = ['X-Authorization'] # noqa: E501
|
|
1618
|
+
|
|
1619
|
+
return self.api_client.call_api(
|
|
1620
|
+
'/api/entityGroupInfosHierarchy/{ownerType}/{ownerId}/{groupType}{?page,pageSize,sortOrder,sortProperty,textSearch}', 'GET',
|
|
1621
|
+
path_params,
|
|
1622
|
+
query_params,
|
|
1623
|
+
header_params,
|
|
1624
|
+
body=body_params,
|
|
1625
|
+
post_params=form_params,
|
|
1626
|
+
files=local_var_files,
|
|
1627
|
+
response_type='PageDataEntityInfo', # noqa: E501
|
|
1628
|
+
auth_settings=auth_settings,
|
|
1629
|
+
async_req=params.get('async_req'),
|
|
1630
|
+
_return_http_data_only=params.get('_return_http_data_only'),
|
|
1631
|
+
_preload_content=params.get('_preload_content', True),
|
|
1632
|
+
_request_timeout=params.get('_request_timeout'),
|
|
1633
|
+
collection_formats=collection_formats)
|
|
1634
|
+
|
|
1635
|
+
def get_entity_groups_by_ids_using_get(self, entity_group_ids, **kwargs): # noqa: E501
|
|
1636
|
+
"""Get Entity Groups by Ids (getEntityGroupsByIds) # noqa: E501
|
|
1637
|
+
|
|
1638
|
+
Fetch the list of Entity Group Info objects based on the provided entity group ids list. Entity group allows you to group multiple entities of the same entity type (Device, Asset, Customer, User, Dashboard, etc). Entity Group always have an owner - particular Tenant or Customer. Each entity may belong to multiple groups simultaneously.Entity Group Info extends Entity Group object and adds 'ownerIds' - a list of owner ids. Available for users with 'TENANT_ADMIN' or 'CUSTOMER_USER' authority. Security check is performed to verify that the user has 'READ' permission for specified group. # noqa: E501
|
|
1639
|
+
This method makes a synchronous HTTP request by default. To make an
|
|
1640
|
+
asynchronous HTTP request, please pass async_req=True
|
|
1641
|
+
>>> thread = api.get_entity_groups_by_ids_using_get(entity_group_ids, async_req=True)
|
|
1642
|
+
>>> result = thread.get()
|
|
1643
|
+
|
|
1644
|
+
:param async_req bool
|
|
1645
|
+
:param str entity_group_ids: A list of group ids, separated by comma ',' (required)
|
|
1646
|
+
:return: list[EntityGroupInfo]
|
|
1647
|
+
If the method is called asynchronously,
|
|
1648
|
+
returns the request thread.
|
|
1649
|
+
"""
|
|
1650
|
+
kwargs['_return_http_data_only'] = True
|
|
1651
|
+
if kwargs.get('async_req'):
|
|
1652
|
+
return self.get_entity_groups_by_ids_using_get_with_http_info(entity_group_ids, **kwargs) # noqa: E501
|
|
1653
|
+
else:
|
|
1654
|
+
(data) = self.get_entity_groups_by_ids_using_get_with_http_info(entity_group_ids, **kwargs) # noqa: E501
|
|
1655
|
+
return data
|
|
1656
|
+
|
|
1657
|
+
def get_entity_groups_by_ids_using_get_with_http_info(self, entity_group_ids, **kwargs): # noqa: E501
|
|
1658
|
+
"""Get Entity Groups by Ids (getEntityGroupsByIds) # noqa: E501
|
|
1659
|
+
|
|
1660
|
+
Fetch the list of Entity Group Info objects based on the provided entity group ids list. Entity group allows you to group multiple entities of the same entity type (Device, Asset, Customer, User, Dashboard, etc). Entity Group always have an owner - particular Tenant or Customer. Each entity may belong to multiple groups simultaneously.Entity Group Info extends Entity Group object and adds 'ownerIds' - a list of owner ids. Available for users with 'TENANT_ADMIN' or 'CUSTOMER_USER' authority. Security check is performed to verify that the user has 'READ' permission for specified group. # noqa: E501
|
|
1661
|
+
This method makes a synchronous HTTP request by default. To make an
|
|
1662
|
+
asynchronous HTTP request, please pass async_req=True
|
|
1663
|
+
>>> thread = api.get_entity_groups_by_ids_using_get_with_http_info(entity_group_ids, async_req=True)
|
|
1664
|
+
>>> result = thread.get()
|
|
1665
|
+
|
|
1666
|
+
:param async_req bool
|
|
1667
|
+
:param str entity_group_ids: A list of group ids, separated by comma ',' (required)
|
|
1668
|
+
:return: list[EntityGroupInfo]
|
|
1669
|
+
If the method is called asynchronously,
|
|
1670
|
+
returns the request thread.
|
|
1671
|
+
"""
|
|
1672
|
+
|
|
1673
|
+
all_params = ['entity_group_ids'] # noqa: E501
|
|
1674
|
+
all_params.append('async_req')
|
|
1675
|
+
all_params.append('_return_http_data_only')
|
|
1676
|
+
all_params.append('_preload_content')
|
|
1677
|
+
all_params.append('_request_timeout')
|
|
1678
|
+
|
|
1679
|
+
params = locals()
|
|
1680
|
+
for key, val in six.iteritems(params['kwargs']):
|
|
1681
|
+
if key not in all_params:
|
|
1682
|
+
raise TypeError(
|
|
1683
|
+
"Got an unexpected keyword argument '%s'"
|
|
1684
|
+
" to method get_entity_groups_by_ids_using_get" % key
|
|
1685
|
+
)
|
|
1686
|
+
params[key] = val
|
|
1687
|
+
del params['kwargs']
|
|
1688
|
+
# verify the required parameter 'entity_group_ids' is set
|
|
1689
|
+
if ('entity_group_ids' not in params or
|
|
1690
|
+
params['entity_group_ids'] is None):
|
|
1691
|
+
raise ValueError("Missing the required parameter `entity_group_ids` when calling `get_entity_groups_by_ids_using_get`") # noqa: E501
|
|
1692
|
+
|
|
1693
|
+
collection_formats = {}
|
|
1694
|
+
|
|
1695
|
+
path_params = {}
|
|
1696
|
+
|
|
1697
|
+
query_params = []
|
|
1698
|
+
if 'entity_group_ids' in params:
|
|
1699
|
+
query_params.append(('entityGroupIds', params['entity_group_ids'])) # noqa: E501
|
|
1700
|
+
|
|
1701
|
+
header_params = {}
|
|
1702
|
+
|
|
1703
|
+
form_params = []
|
|
1704
|
+
local_var_files = {}
|
|
1705
|
+
|
|
1706
|
+
body_params = None
|
|
1707
|
+
# HTTP header `Accept`
|
|
1708
|
+
header_params['Accept'] = self.api_client.select_header_accept(
|
|
1709
|
+
['application/json']) # noqa: E501
|
|
1710
|
+
|
|
1711
|
+
# Authentication setting
|
|
1712
|
+
auth_settings = ['X-Authorization'] # noqa: E501
|
|
1713
|
+
|
|
1714
|
+
return self.api_client.call_api(
|
|
1715
|
+
'/api/entityGroups{?entityGroupIds}', 'GET',
|
|
1716
|
+
path_params,
|
|
1717
|
+
query_params,
|
|
1718
|
+
header_params,
|
|
1719
|
+
body=body_params,
|
|
1720
|
+
post_params=form_params,
|
|
1721
|
+
files=local_var_files,
|
|
1722
|
+
response_type='list[EntityGroupInfo]', # noqa: E501
|
|
1723
|
+
auth_settings=auth_settings,
|
|
1724
|
+
async_req=params.get('async_req'),
|
|
1725
|
+
_return_http_data_only=params.get('_return_http_data_only'),
|
|
1726
|
+
_preload_content=params.get('_preload_content', True),
|
|
1727
|
+
_request_timeout=params.get('_request_timeout'),
|
|
1728
|
+
collection_formats=collection_formats)
|
|
1729
|
+
|
|
1730
|
+
def get_entity_groups_by_owner_and_type_and_page_link_using_get(self, owner_type, owner_id, group_type, page_size, page, **kwargs): # noqa: E501
|
|
1731
|
+
"""Get Entity Groups by owner and entity type and page link (getEntityGroupsByOwnerAndTypeAndPageLink) # noqa: E501
|
|
1732
|
+
|
|
1733
|
+
Returns a page of Entity Group objects based on the provided Owner Id and Entity Type and Page Link. Entity group allows you to group multiple entities of the same entity type (Device, Asset, Customer, User, Dashboard, etc). Entity Group always have an owner - particular Tenant or Customer. Each entity may belong to multiple groups simultaneously.You can specify parameters to filter the results. The result is wrapped with PageData object that allows you to iterate over result set using pagination. See the 'Model' tab of the Response Class for more details. Available for users with 'TENANT_ADMIN' or 'CUSTOMER_USER' authority. Security check is performed to verify that the user has 'READ' permission for specified group. # noqa: E501
|
|
1734
|
+
This method makes a synchronous HTTP request by default. To make an
|
|
1735
|
+
asynchronous HTTP request, please pass async_req=True
|
|
1736
|
+
>>> thread = api.get_entity_groups_by_owner_and_type_and_page_link_using_get(owner_type, owner_id, group_type, page_size, page, async_req=True)
|
|
1737
|
+
>>> result = thread.get()
|
|
1738
|
+
|
|
1739
|
+
:param async_req bool
|
|
1740
|
+
:param str owner_type: Tenant or Customer (required)
|
|
1741
|
+
:param str owner_id: A string value representing the Tenant or Customer id (required)
|
|
1742
|
+
:param str group_type: Entity Group type (required)
|
|
1743
|
+
:param int page_size: Maximum amount of entities in a one page (required)
|
|
1744
|
+
:param int page: Sequence number of page starting from 0 (required)
|
|
1745
|
+
:param str text_search: The case insensitive 'startsWith' filter based on the entity group name.
|
|
1746
|
+
:param str sort_property: Property of entity to sort by
|
|
1747
|
+
:param str sort_order: Sort order. ASC (ASCENDING) or DESC (DESCENDING)
|
|
1748
|
+
:return: PageDataEntityGroupInfo
|
|
1749
|
+
If the method is called asynchronously,
|
|
1750
|
+
returns the request thread.
|
|
1751
|
+
"""
|
|
1752
|
+
kwargs['_return_http_data_only'] = True
|
|
1753
|
+
if kwargs.get('async_req'):
|
|
1754
|
+
return self.get_entity_groups_by_owner_and_type_and_page_link_using_get_with_http_info(owner_type, owner_id, group_type, page_size, page, **kwargs) # noqa: E501
|
|
1755
|
+
else:
|
|
1756
|
+
(data) = self.get_entity_groups_by_owner_and_type_and_page_link_using_get_with_http_info(owner_type, owner_id, group_type, page_size, page, **kwargs) # noqa: E501
|
|
1757
|
+
return data
|
|
1758
|
+
|
|
1759
|
+
def get_entity_groups_by_owner_and_type_and_page_link_using_get_with_http_info(self, owner_type, owner_id, group_type, page_size, page, **kwargs): # noqa: E501
|
|
1760
|
+
"""Get Entity Groups by owner and entity type and page link (getEntityGroupsByOwnerAndTypeAndPageLink) # noqa: E501
|
|
1761
|
+
|
|
1762
|
+
Returns a page of Entity Group objects based on the provided Owner Id and Entity Type and Page Link. Entity group allows you to group multiple entities of the same entity type (Device, Asset, Customer, User, Dashboard, etc). Entity Group always have an owner - particular Tenant or Customer. Each entity may belong to multiple groups simultaneously.You can specify parameters to filter the results. The result is wrapped with PageData object that allows you to iterate over result set using pagination. See the 'Model' tab of the Response Class for more details. Available for users with 'TENANT_ADMIN' or 'CUSTOMER_USER' authority. Security check is performed to verify that the user has 'READ' permission for specified group. # noqa: E501
|
|
1763
|
+
This method makes a synchronous HTTP request by default. To make an
|
|
1764
|
+
asynchronous HTTP request, please pass async_req=True
|
|
1765
|
+
>>> thread = api.get_entity_groups_by_owner_and_type_and_page_link_using_get_with_http_info(owner_type, owner_id, group_type, page_size, page, async_req=True)
|
|
1766
|
+
>>> result = thread.get()
|
|
1767
|
+
|
|
1768
|
+
:param async_req bool
|
|
1769
|
+
:param str owner_type: Tenant or Customer (required)
|
|
1770
|
+
:param str owner_id: A string value representing the Tenant or Customer id (required)
|
|
1771
|
+
:param str group_type: Entity Group type (required)
|
|
1772
|
+
:param int page_size: Maximum amount of entities in a one page (required)
|
|
1773
|
+
:param int page: Sequence number of page starting from 0 (required)
|
|
1774
|
+
:param str text_search: The case insensitive 'startsWith' filter based on the entity group name.
|
|
1775
|
+
:param str sort_property: Property of entity to sort by
|
|
1776
|
+
:param str sort_order: Sort order. ASC (ASCENDING) or DESC (DESCENDING)
|
|
1777
|
+
:return: PageDataEntityGroupInfo
|
|
1778
|
+
If the method is called asynchronously,
|
|
1779
|
+
returns the request thread.
|
|
1780
|
+
"""
|
|
1781
|
+
|
|
1782
|
+
all_params = ['owner_type', 'owner_id', 'group_type', 'page_size', 'page', 'text_search', 'sort_property', 'sort_order'] # noqa: E501
|
|
1783
|
+
all_params.append('async_req')
|
|
1784
|
+
all_params.append('_return_http_data_only')
|
|
1785
|
+
all_params.append('_preload_content')
|
|
1786
|
+
all_params.append('_request_timeout')
|
|
1787
|
+
|
|
1788
|
+
params = locals()
|
|
1789
|
+
for key, val in six.iteritems(params['kwargs']):
|
|
1790
|
+
if key not in all_params:
|
|
1791
|
+
raise TypeError(
|
|
1792
|
+
"Got an unexpected keyword argument '%s'"
|
|
1793
|
+
" to method get_entity_groups_by_owner_and_type_and_page_link_using_get" % key
|
|
1794
|
+
)
|
|
1795
|
+
params[key] = val
|
|
1796
|
+
del params['kwargs']
|
|
1797
|
+
# verify the required parameter 'owner_type' is set
|
|
1798
|
+
if ('owner_type' not in params or
|
|
1799
|
+
params['owner_type'] is None):
|
|
1800
|
+
raise ValueError("Missing the required parameter `owner_type` when calling `get_entity_groups_by_owner_and_type_and_page_link_using_get`") # noqa: E501
|
|
1801
|
+
# verify the required parameter 'owner_id' is set
|
|
1802
|
+
if ('owner_id' not in params or
|
|
1803
|
+
params['owner_id'] is None):
|
|
1804
|
+
raise ValueError("Missing the required parameter `owner_id` when calling `get_entity_groups_by_owner_and_type_and_page_link_using_get`") # noqa: E501
|
|
1805
|
+
# verify the required parameter 'group_type' is set
|
|
1806
|
+
if ('group_type' not in params or
|
|
1807
|
+
params['group_type'] is None):
|
|
1808
|
+
raise ValueError("Missing the required parameter `group_type` when calling `get_entity_groups_by_owner_and_type_and_page_link_using_get`") # noqa: E501
|
|
1809
|
+
# verify the required parameter 'page_size' is set
|
|
1810
|
+
if ('page_size' not in params or
|
|
1811
|
+
params['page_size'] is None):
|
|
1812
|
+
raise ValueError("Missing the required parameter `page_size` when calling `get_entity_groups_by_owner_and_type_and_page_link_using_get`") # noqa: E501
|
|
1813
|
+
# verify the required parameter 'page' is set
|
|
1814
|
+
if ('page' not in params or
|
|
1815
|
+
params['page'] is None):
|
|
1816
|
+
raise ValueError("Missing the required parameter `page` when calling `get_entity_groups_by_owner_and_type_and_page_link_using_get`") # noqa: E501
|
|
1817
|
+
|
|
1818
|
+
collection_formats = {}
|
|
1819
|
+
|
|
1820
|
+
path_params = {}
|
|
1821
|
+
if 'owner_type' in params:
|
|
1822
|
+
path_params['ownerType'] = params['owner_type'] # noqa: E501
|
|
1823
|
+
if 'owner_id' in params:
|
|
1824
|
+
path_params['ownerId'] = params['owner_id'] # noqa: E501
|
|
1825
|
+
if 'group_type' in params:
|
|
1826
|
+
path_params['groupType'] = params['group_type'] # noqa: E501
|
|
1827
|
+
|
|
1828
|
+
query_params = []
|
|
1829
|
+
if 'page_size' in params:
|
|
1830
|
+
query_params.append(('pageSize', params['page_size'])) # noqa: E501
|
|
1831
|
+
if 'page' in params:
|
|
1832
|
+
query_params.append(('page', params['page'])) # noqa: E501
|
|
1833
|
+
if 'text_search' in params:
|
|
1834
|
+
query_params.append(('textSearch', params['text_search'])) # noqa: E501
|
|
1835
|
+
if 'sort_property' in params:
|
|
1836
|
+
query_params.append(('sortProperty', params['sort_property'])) # noqa: E501
|
|
1837
|
+
if 'sort_order' in params:
|
|
1838
|
+
query_params.append(('sortOrder', params['sort_order'])) # noqa: E501
|
|
1839
|
+
|
|
1840
|
+
header_params = {}
|
|
1841
|
+
|
|
1842
|
+
form_params = []
|
|
1843
|
+
local_var_files = {}
|
|
1844
|
+
|
|
1845
|
+
body_params = None
|
|
1846
|
+
# HTTP header `Accept`
|
|
1847
|
+
header_params['Accept'] = self.api_client.select_header_accept(
|
|
1848
|
+
['application/json']) # noqa: E501
|
|
1849
|
+
|
|
1850
|
+
# Authentication setting
|
|
1851
|
+
auth_settings = ['X-Authorization'] # noqa: E501
|
|
1852
|
+
|
|
1853
|
+
return self.api_client.call_api(
|
|
1854
|
+
'/api/entityGroups/{ownerType}/{ownerId}/{groupType}{?page,pageSize,sortOrder,sortProperty,textSearch}', 'GET',
|
|
1855
|
+
path_params,
|
|
1856
|
+
query_params,
|
|
1857
|
+
header_params,
|
|
1858
|
+
body=body_params,
|
|
1859
|
+
post_params=form_params,
|
|
1860
|
+
files=local_var_files,
|
|
1861
|
+
response_type='PageDataEntityGroupInfo', # noqa: E501
|
|
1862
|
+
auth_settings=auth_settings,
|
|
1863
|
+
async_req=params.get('async_req'),
|
|
1864
|
+
_return_http_data_only=params.get('_return_http_data_only'),
|
|
1865
|
+
_preload_content=params.get('_preload_content', True),
|
|
1866
|
+
_request_timeout=params.get('_request_timeout'),
|
|
1867
|
+
collection_formats=collection_formats)
|
|
1868
|
+
|
|
1869
|
+
def get_entity_groups_by_owner_and_type_using_get(self, owner_type, owner_id, group_type, **kwargs): # noqa: E501
|
|
1870
|
+
"""Get Entity Groups by owner and entity type (getEntityGroupsByOwnerAndType) # noqa: E501
|
|
1871
|
+
|
|
1872
|
+
Fetch the list of Entity Group Info objects based on the provided Owner Id and Entity Type. Entity group allows you to group multiple entities of the same entity type (Device, Asset, Customer, User, Dashboard, etc). Entity Group always have an owner - particular Tenant or Customer. Each entity may belong to multiple groups simultaneously.Entity Group Info extends Entity Group object and adds 'ownerIds' - a list of owner ids. Available for users with 'TENANT_ADMIN' or 'CUSTOMER_USER' authority. Security check is performed to verify that the user has 'READ' permission for specified group. # noqa: E501
|
|
1873
|
+
This method makes a synchronous HTTP request by default. To make an
|
|
1874
|
+
asynchronous HTTP request, please pass async_req=True
|
|
1875
|
+
>>> thread = api.get_entity_groups_by_owner_and_type_using_get(owner_type, owner_id, group_type, async_req=True)
|
|
1876
|
+
>>> result = thread.get()
|
|
1877
|
+
|
|
1878
|
+
:param async_req bool
|
|
1879
|
+
:param str owner_type: Tenant or Customer (required)
|
|
1880
|
+
:param str owner_id: A string value representing the Tenant or Customer id (required)
|
|
1881
|
+
:param str group_type: Entity Group type (required)
|
|
1882
|
+
:return: list[EntityGroupInfo]
|
|
1883
|
+
If the method is called asynchronously,
|
|
1884
|
+
returns the request thread.
|
|
1885
|
+
"""
|
|
1886
|
+
kwargs['_return_http_data_only'] = True
|
|
1887
|
+
if kwargs.get('async_req'):
|
|
1888
|
+
return self.get_entity_groups_by_owner_and_type_using_get_with_http_info(owner_type, owner_id, group_type, **kwargs) # noqa: E501
|
|
1889
|
+
else:
|
|
1890
|
+
(data) = self.get_entity_groups_by_owner_and_type_using_get_with_http_info(owner_type, owner_id, group_type, **kwargs) # noqa: E501
|
|
1891
|
+
return data
|
|
1892
|
+
|
|
1893
|
+
def get_entity_groups_by_owner_and_type_using_get_with_http_info(self, owner_type, owner_id, group_type, **kwargs): # noqa: E501
|
|
1894
|
+
"""Get Entity Groups by owner and entity type (getEntityGroupsByOwnerAndType) # noqa: E501
|
|
1895
|
+
|
|
1896
|
+
Fetch the list of Entity Group Info objects based on the provided Owner Id and Entity Type. Entity group allows you to group multiple entities of the same entity type (Device, Asset, Customer, User, Dashboard, etc). Entity Group always have an owner - particular Tenant or Customer. Each entity may belong to multiple groups simultaneously.Entity Group Info extends Entity Group object and adds 'ownerIds' - a list of owner ids. Available for users with 'TENANT_ADMIN' or 'CUSTOMER_USER' authority. Security check is performed to verify that the user has 'READ' permission for specified group. # noqa: E501
|
|
1897
|
+
This method makes a synchronous HTTP request by default. To make an
|
|
1898
|
+
asynchronous HTTP request, please pass async_req=True
|
|
1899
|
+
>>> thread = api.get_entity_groups_by_owner_and_type_using_get_with_http_info(owner_type, owner_id, group_type, async_req=True)
|
|
1900
|
+
>>> result = thread.get()
|
|
1901
|
+
|
|
1902
|
+
:param async_req bool
|
|
1903
|
+
:param str owner_type: Tenant or Customer (required)
|
|
1904
|
+
:param str owner_id: A string value representing the Tenant or Customer id (required)
|
|
1905
|
+
:param str group_type: Entity Group type (required)
|
|
1906
|
+
:return: list[EntityGroupInfo]
|
|
1907
|
+
If the method is called asynchronously,
|
|
1908
|
+
returns the request thread.
|
|
1909
|
+
"""
|
|
1910
|
+
|
|
1911
|
+
all_params = ['owner_type', 'owner_id', 'group_type'] # noqa: E501
|
|
1912
|
+
all_params.append('async_req')
|
|
1913
|
+
all_params.append('_return_http_data_only')
|
|
1914
|
+
all_params.append('_preload_content')
|
|
1915
|
+
all_params.append('_request_timeout')
|
|
1916
|
+
|
|
1917
|
+
params = locals()
|
|
1918
|
+
for key, val in six.iteritems(params['kwargs']):
|
|
1919
|
+
if key not in all_params:
|
|
1920
|
+
raise TypeError(
|
|
1921
|
+
"Got an unexpected keyword argument '%s'"
|
|
1922
|
+
" to method get_entity_groups_by_owner_and_type_using_get" % key
|
|
1923
|
+
)
|
|
1924
|
+
params[key] = val
|
|
1925
|
+
del params['kwargs']
|
|
1926
|
+
# verify the required parameter 'owner_type' is set
|
|
1927
|
+
if ('owner_type' not in params or
|
|
1928
|
+
params['owner_type'] is None):
|
|
1929
|
+
raise ValueError("Missing the required parameter `owner_type` when calling `get_entity_groups_by_owner_and_type_using_get`") # noqa: E501
|
|
1930
|
+
# verify the required parameter 'owner_id' is set
|
|
1931
|
+
if ('owner_id' not in params or
|
|
1932
|
+
params['owner_id'] is None):
|
|
1933
|
+
raise ValueError("Missing the required parameter `owner_id` when calling `get_entity_groups_by_owner_and_type_using_get`") # noqa: E501
|
|
1934
|
+
# verify the required parameter 'group_type' is set
|
|
1935
|
+
if ('group_type' not in params or
|
|
1936
|
+
params['group_type'] is None):
|
|
1937
|
+
raise ValueError("Missing the required parameter `group_type` when calling `get_entity_groups_by_owner_and_type_using_get`") # noqa: E501
|
|
1938
|
+
|
|
1939
|
+
collection_formats = {}
|
|
1940
|
+
|
|
1941
|
+
path_params = {}
|
|
1942
|
+
if 'owner_type' in params:
|
|
1943
|
+
path_params['ownerType'] = params['owner_type'] # noqa: E501
|
|
1944
|
+
if 'owner_id' in params:
|
|
1945
|
+
path_params['ownerId'] = params['owner_id'] # noqa: E501
|
|
1946
|
+
if 'group_type' in params:
|
|
1947
|
+
path_params['groupType'] = params['group_type'] # noqa: E501
|
|
1948
|
+
|
|
1949
|
+
query_params = []
|
|
1950
|
+
|
|
1951
|
+
header_params = {}
|
|
1952
|
+
|
|
1953
|
+
form_params = []
|
|
1954
|
+
local_var_files = {}
|
|
1955
|
+
|
|
1956
|
+
body_params = None
|
|
1957
|
+
# HTTP header `Accept`
|
|
1958
|
+
header_params['Accept'] = self.api_client.select_header_accept(
|
|
1959
|
+
['application/json']) # noqa: E501
|
|
1960
|
+
|
|
1961
|
+
# Authentication setting
|
|
1962
|
+
auth_settings = ['X-Authorization'] # noqa: E501
|
|
1963
|
+
|
|
1964
|
+
return self.api_client.call_api(
|
|
1965
|
+
'/api/entityGroups/{ownerType}/{ownerId}/{groupType}', 'GET',
|
|
1966
|
+
path_params,
|
|
1967
|
+
query_params,
|
|
1968
|
+
header_params,
|
|
1969
|
+
body=body_params,
|
|
1970
|
+
post_params=form_params,
|
|
1971
|
+
files=local_var_files,
|
|
1972
|
+
response_type='list[EntityGroupInfo]', # noqa: E501
|
|
1973
|
+
auth_settings=auth_settings,
|
|
1974
|
+
async_req=params.get('async_req'),
|
|
1975
|
+
_return_http_data_only=params.get('_return_http_data_only'),
|
|
1976
|
+
_preload_content=params.get('_preload_content', True),
|
|
1977
|
+
_request_timeout=params.get('_request_timeout'),
|
|
1978
|
+
collection_formats=collection_formats)
|
|
1979
|
+
|
|
1980
|
+
def get_entity_groups_by_type_and_page_link_using_get(self, group_type, page_size, page, **kwargs): # noqa: E501
|
|
1981
|
+
"""Get Entity Groups by entity type and page link (getEntityGroupsByTypeAndPageLink) # noqa: E501
|
|
1982
|
+
|
|
1983
|
+
Returns a page of Entity Group Info objects based on the provided Entity Type and Page Link. Entity group allows you to group multiple entities of the same entity type (Device, Asset, Customer, User, Dashboard, etc). Entity Group always have an owner - particular Tenant or Customer. Each entity may belong to multiple groups simultaneously.Entity Group Info extends Entity Group object and adds 'ownerIds' - a list of owner ids.You can specify parameters to filter the results. The result is wrapped with PageData object that allows you to iterate over result set using pagination. See the 'Model' tab of the Response Class for more details. Available for users with 'TENANT_ADMIN' or 'CUSTOMER_USER' authority. Security check is performed to verify that the user has 'READ' permission for specified group. # noqa: E501
|
|
1984
|
+
This method makes a synchronous HTTP request by default. To make an
|
|
1985
|
+
asynchronous HTTP request, please pass async_req=True
|
|
1986
|
+
>>> thread = api.get_entity_groups_by_type_and_page_link_using_get(group_type, page_size, page, async_req=True)
|
|
1987
|
+
>>> result = thread.get()
|
|
1988
|
+
|
|
1989
|
+
:param async_req bool
|
|
1990
|
+
:param str group_type: Entity Group type (required)
|
|
1991
|
+
:param int page_size: Maximum amount of entities in a one page (required)
|
|
1992
|
+
:param int page: Sequence number of page starting from 0 (required)
|
|
1993
|
+
:param bool include_shared: Whether to include shared entity groups.
|
|
1994
|
+
:param str text_search: The case insensitive 'startsWith' filter based on the entity group name.
|
|
1995
|
+
:param str sort_property: Property of entity to sort by
|
|
1996
|
+
:param str sort_order: Sort order. ASC (ASCENDING) or DESC (DESCENDING)
|
|
1997
|
+
:return: PageDataEntityGroupInfo
|
|
1998
|
+
If the method is called asynchronously,
|
|
1999
|
+
returns the request thread.
|
|
2000
|
+
"""
|
|
2001
|
+
kwargs['_return_http_data_only'] = True
|
|
2002
|
+
if kwargs.get('async_req'):
|
|
2003
|
+
return self.get_entity_groups_by_type_and_page_link_using_get_with_http_info(group_type, page_size, page, **kwargs) # noqa: E501
|
|
2004
|
+
else:
|
|
2005
|
+
(data) = self.get_entity_groups_by_type_and_page_link_using_get_with_http_info(group_type, page_size, page, **kwargs) # noqa: E501
|
|
2006
|
+
return data
|
|
2007
|
+
|
|
2008
|
+
def get_entity_groups_by_type_and_page_link_using_get_with_http_info(self, group_type, page_size, page, **kwargs): # noqa: E501
|
|
2009
|
+
"""Get Entity Groups by entity type and page link (getEntityGroupsByTypeAndPageLink) # noqa: E501
|
|
2010
|
+
|
|
2011
|
+
Returns a page of Entity Group Info objects based on the provided Entity Type and Page Link. Entity group allows you to group multiple entities of the same entity type (Device, Asset, Customer, User, Dashboard, etc). Entity Group always have an owner - particular Tenant or Customer. Each entity may belong to multiple groups simultaneously.Entity Group Info extends Entity Group object and adds 'ownerIds' - a list of owner ids.You can specify parameters to filter the results. The result is wrapped with PageData object that allows you to iterate over result set using pagination. See the 'Model' tab of the Response Class for more details. Available for users with 'TENANT_ADMIN' or 'CUSTOMER_USER' authority. Security check is performed to verify that the user has 'READ' permission for specified group. # noqa: E501
|
|
2012
|
+
This method makes a synchronous HTTP request by default. To make an
|
|
2013
|
+
asynchronous HTTP request, please pass async_req=True
|
|
2014
|
+
>>> thread = api.get_entity_groups_by_type_and_page_link_using_get_with_http_info(group_type, page_size, page, async_req=True)
|
|
2015
|
+
>>> result = thread.get()
|
|
2016
|
+
|
|
2017
|
+
:param async_req bool
|
|
2018
|
+
:param str group_type: Entity Group type (required)
|
|
2019
|
+
:param int page_size: Maximum amount of entities in a one page (required)
|
|
2020
|
+
:param int page: Sequence number of page starting from 0 (required)
|
|
2021
|
+
:param bool include_shared: Whether to include shared entity groups.
|
|
2022
|
+
:param str text_search: The case insensitive 'startsWith' filter based on the entity group name.
|
|
2023
|
+
:param str sort_property: Property of entity to sort by
|
|
2024
|
+
:param str sort_order: Sort order. ASC (ASCENDING) or DESC (DESCENDING)
|
|
2025
|
+
:return: PageDataEntityGroupInfo
|
|
2026
|
+
If the method is called asynchronously,
|
|
2027
|
+
returns the request thread.
|
|
2028
|
+
"""
|
|
2029
|
+
|
|
2030
|
+
all_params = ['group_type', 'page_size', 'page', 'include_shared', 'text_search', 'sort_property', 'sort_order'] # noqa: E501
|
|
2031
|
+
all_params.append('async_req')
|
|
2032
|
+
all_params.append('_return_http_data_only')
|
|
2033
|
+
all_params.append('_preload_content')
|
|
2034
|
+
all_params.append('_request_timeout')
|
|
2035
|
+
|
|
2036
|
+
params = locals()
|
|
2037
|
+
for key, val in six.iteritems(params['kwargs']):
|
|
2038
|
+
if key not in all_params:
|
|
2039
|
+
raise TypeError(
|
|
2040
|
+
"Got an unexpected keyword argument '%s'"
|
|
2041
|
+
" to method get_entity_groups_by_type_and_page_link_using_get" % key
|
|
2042
|
+
)
|
|
2043
|
+
params[key] = val
|
|
2044
|
+
del params['kwargs']
|
|
2045
|
+
# verify the required parameter 'group_type' is set
|
|
2046
|
+
if ('group_type' not in params or
|
|
2047
|
+
params['group_type'] is None):
|
|
2048
|
+
raise ValueError("Missing the required parameter `group_type` when calling `get_entity_groups_by_type_and_page_link_using_get`") # noqa: E501
|
|
2049
|
+
# verify the required parameter 'page_size' is set
|
|
2050
|
+
if ('page_size' not in params or
|
|
2051
|
+
params['page_size'] is None):
|
|
2052
|
+
raise ValueError("Missing the required parameter `page_size` when calling `get_entity_groups_by_type_and_page_link_using_get`") # noqa: E501
|
|
2053
|
+
# verify the required parameter 'page' is set
|
|
2054
|
+
if ('page' not in params or
|
|
2055
|
+
params['page'] is None):
|
|
2056
|
+
raise ValueError("Missing the required parameter `page` when calling `get_entity_groups_by_type_and_page_link_using_get`") # noqa: E501
|
|
2057
|
+
|
|
2058
|
+
collection_formats = {}
|
|
2059
|
+
|
|
2060
|
+
path_params = {}
|
|
2061
|
+
if 'group_type' in params:
|
|
2062
|
+
path_params['groupType'] = params['group_type'] # noqa: E501
|
|
2063
|
+
|
|
2064
|
+
query_params = []
|
|
2065
|
+
if 'include_shared' in params:
|
|
2066
|
+
query_params.append(('includeShared', params['include_shared'])) # noqa: E501
|
|
2067
|
+
if 'page_size' in params:
|
|
2068
|
+
query_params.append(('pageSize', params['page_size'])) # noqa: E501
|
|
2069
|
+
if 'page' in params:
|
|
2070
|
+
query_params.append(('page', params['page'])) # noqa: E501
|
|
2071
|
+
if 'text_search' in params:
|
|
2072
|
+
query_params.append(('textSearch', params['text_search'])) # noqa: E501
|
|
2073
|
+
if 'sort_property' in params:
|
|
2074
|
+
query_params.append(('sortProperty', params['sort_property'])) # noqa: E501
|
|
2075
|
+
if 'sort_order' in params:
|
|
2076
|
+
query_params.append(('sortOrder', params['sort_order'])) # noqa: E501
|
|
2077
|
+
|
|
2078
|
+
header_params = {}
|
|
2079
|
+
|
|
2080
|
+
form_params = []
|
|
2081
|
+
local_var_files = {}
|
|
2082
|
+
|
|
2083
|
+
body_params = None
|
|
2084
|
+
# HTTP header `Accept`
|
|
2085
|
+
header_params['Accept'] = self.api_client.select_header_accept(
|
|
2086
|
+
['application/json']) # noqa: E501
|
|
2087
|
+
|
|
2088
|
+
# Authentication setting
|
|
2089
|
+
auth_settings = ['X-Authorization'] # noqa: E501
|
|
2090
|
+
|
|
2091
|
+
return self.api_client.call_api(
|
|
2092
|
+
'/api/entityGroups/{groupType}{?includeShared,page,pageSize,sortOrder,sortProperty,textSearch}', 'GET',
|
|
2093
|
+
path_params,
|
|
2094
|
+
query_params,
|
|
2095
|
+
header_params,
|
|
2096
|
+
body=body_params,
|
|
2097
|
+
post_params=form_params,
|
|
2098
|
+
files=local_var_files,
|
|
2099
|
+
response_type='PageDataEntityGroupInfo', # noqa: E501
|
|
2100
|
+
auth_settings=auth_settings,
|
|
2101
|
+
async_req=params.get('async_req'),
|
|
2102
|
+
_return_http_data_only=params.get('_return_http_data_only'),
|
|
2103
|
+
_preload_content=params.get('_preload_content', True),
|
|
2104
|
+
_request_timeout=params.get('_request_timeout'),
|
|
2105
|
+
collection_formats=collection_formats)
|
|
2106
|
+
|
|
2107
|
+
def get_entity_groups_by_type_using_get(self, group_type, **kwargs): # noqa: E501
|
|
2108
|
+
"""Get Entity Groups by entity type (getEntityGroupsByType) # noqa: E501
|
|
2109
|
+
|
|
2110
|
+
Fetch the list of Entity Group Info objects based on the provided Entity Type. Entity group allows you to group multiple entities of the same entity type (Device, Asset, Customer, User, Dashboard, etc). Entity Group always have an owner - particular Tenant or Customer. Each entity may belong to multiple groups simultaneously.Entity Group Info extends Entity Group object and adds 'ownerIds' - a list of owner ids. Available for users with 'TENANT_ADMIN' or 'CUSTOMER_USER' authority. Security check is performed to verify that the user has 'READ' permission for specified group. # noqa: E501
|
|
2111
|
+
This method makes a synchronous HTTP request by default. To make an
|
|
2112
|
+
asynchronous HTTP request, please pass async_req=True
|
|
2113
|
+
>>> thread = api.get_entity_groups_by_type_using_get(group_type, async_req=True)
|
|
2114
|
+
>>> result = thread.get()
|
|
2115
|
+
|
|
2116
|
+
:param async_req bool
|
|
2117
|
+
:param str group_type: Entity Group type (required)
|
|
2118
|
+
:param bool include_shared: Whether to include shared entity groups.
|
|
2119
|
+
:return: list[EntityGroupInfo]
|
|
2120
|
+
If the method is called asynchronously,
|
|
2121
|
+
returns the request thread.
|
|
2122
|
+
"""
|
|
2123
|
+
kwargs['_return_http_data_only'] = True
|
|
2124
|
+
if kwargs.get('async_req'):
|
|
2125
|
+
return self.get_entity_groups_by_type_using_get_with_http_info(group_type, **kwargs) # noqa: E501
|
|
2126
|
+
else:
|
|
2127
|
+
(data) = self.get_entity_groups_by_type_using_get_with_http_info(group_type, **kwargs) # noqa: E501
|
|
2128
|
+
return data
|
|
2129
|
+
|
|
2130
|
+
def get_entity_groups_by_type_using_get_with_http_info(self, group_type, **kwargs): # noqa: E501
|
|
2131
|
+
"""Get Entity Groups by entity type (getEntityGroupsByType) # noqa: E501
|
|
2132
|
+
|
|
2133
|
+
Fetch the list of Entity Group Info objects based on the provided Entity Type. Entity group allows you to group multiple entities of the same entity type (Device, Asset, Customer, User, Dashboard, etc). Entity Group always have an owner - particular Tenant or Customer. Each entity may belong to multiple groups simultaneously.Entity Group Info extends Entity Group object and adds 'ownerIds' - a list of owner ids. Available for users with 'TENANT_ADMIN' or 'CUSTOMER_USER' authority. Security check is performed to verify that the user has 'READ' permission for specified group. # noqa: E501
|
|
2134
|
+
This method makes a synchronous HTTP request by default. To make an
|
|
2135
|
+
asynchronous HTTP request, please pass async_req=True
|
|
2136
|
+
>>> thread = api.get_entity_groups_by_type_using_get_with_http_info(group_type, async_req=True)
|
|
2137
|
+
>>> result = thread.get()
|
|
2138
|
+
|
|
2139
|
+
:param async_req bool
|
|
2140
|
+
:param str group_type: Entity Group type (required)
|
|
2141
|
+
:param bool include_shared: Whether to include shared entity groups.
|
|
2142
|
+
:return: list[EntityGroupInfo]
|
|
2143
|
+
If the method is called asynchronously,
|
|
2144
|
+
returns the request thread.
|
|
2145
|
+
"""
|
|
2146
|
+
|
|
2147
|
+
all_params = ['group_type', 'include_shared'] # noqa: E501
|
|
2148
|
+
all_params.append('async_req')
|
|
2149
|
+
all_params.append('_return_http_data_only')
|
|
2150
|
+
all_params.append('_preload_content')
|
|
2151
|
+
all_params.append('_request_timeout')
|
|
2152
|
+
|
|
2153
|
+
params = locals()
|
|
2154
|
+
for key, val in six.iteritems(params['kwargs']):
|
|
2155
|
+
if key not in all_params:
|
|
2156
|
+
raise TypeError(
|
|
2157
|
+
"Got an unexpected keyword argument '%s'"
|
|
2158
|
+
" to method get_entity_groups_by_type_using_get" % key
|
|
2159
|
+
)
|
|
2160
|
+
params[key] = val
|
|
2161
|
+
del params['kwargs']
|
|
2162
|
+
# verify the required parameter 'group_type' is set
|
|
2163
|
+
if ('group_type' not in params or
|
|
2164
|
+
params['group_type'] is None):
|
|
2165
|
+
raise ValueError("Missing the required parameter `group_type` when calling `get_entity_groups_by_type_using_get`") # noqa: E501
|
|
2166
|
+
|
|
2167
|
+
collection_formats = {}
|
|
2168
|
+
|
|
2169
|
+
path_params = {}
|
|
2170
|
+
if 'group_type' in params:
|
|
2171
|
+
path_params['groupType'] = params['group_type'] # noqa: E501
|
|
2172
|
+
|
|
2173
|
+
query_params = []
|
|
2174
|
+
if 'include_shared' in params:
|
|
2175
|
+
query_params.append(('includeShared', params['include_shared'])) # noqa: E501
|
|
2176
|
+
|
|
2177
|
+
header_params = {}
|
|
2178
|
+
|
|
2179
|
+
form_params = []
|
|
2180
|
+
local_var_files = {}
|
|
2181
|
+
|
|
2182
|
+
body_params = None
|
|
2183
|
+
# HTTP header `Accept`
|
|
2184
|
+
header_params['Accept'] = self.api_client.select_header_accept(
|
|
2185
|
+
['application/json']) # noqa: E501
|
|
2186
|
+
|
|
2187
|
+
# Authentication setting
|
|
2188
|
+
auth_settings = ['X-Authorization'] # noqa: E501
|
|
2189
|
+
|
|
2190
|
+
return self.api_client.call_api(
|
|
2191
|
+
'/api/entityGroups/{groupType}{?includeShared}', 'GET',
|
|
2192
|
+
path_params,
|
|
2193
|
+
query_params,
|
|
2194
|
+
header_params,
|
|
2195
|
+
body=body_params,
|
|
2196
|
+
post_params=form_params,
|
|
2197
|
+
files=local_var_files,
|
|
2198
|
+
response_type='list[EntityGroupInfo]', # noqa: E501
|
|
2199
|
+
auth_settings=auth_settings,
|
|
2200
|
+
async_req=params.get('async_req'),
|
|
2201
|
+
_return_http_data_only=params.get('_return_http_data_only'),
|
|
2202
|
+
_preload_content=params.get('_preload_content', True),
|
|
2203
|
+
_request_timeout=params.get('_request_timeout'),
|
|
2204
|
+
collection_formats=collection_formats)
|
|
2205
|
+
|
|
2206
|
+
def get_entity_groups_for_entity_using_get(self, entity_type, entity_id, **kwargs): # noqa: E501
|
|
2207
|
+
"""Get Entity Groups by Entity Id (getEntityGroupsForEntity) # noqa: E501
|
|
2208
|
+
|
|
2209
|
+
Returns a list of groups that contain the specified Entity Id. For example, all device groups that contain specific device. The list always contain at least one element - special group 'All'.You can specify parameters to filter the results. The result is wrapped with PageData object that allows you to iterate over result set using pagination. See the 'Model' tab of the Response Class for more details. Available for users with 'TENANT_ADMIN' or 'CUSTOMER_USER' authority. Security check is performed to verify that the user has 'READ' permission for the entity (entities). # noqa: E501
|
|
2210
|
+
This method makes a synchronous HTTP request by default. To make an
|
|
2211
|
+
asynchronous HTTP request, please pass async_req=True
|
|
2212
|
+
>>> thread = api.get_entity_groups_for_entity_using_get(entity_type, entity_id, async_req=True)
|
|
2213
|
+
>>> result = thread.get()
|
|
2214
|
+
|
|
2215
|
+
:param async_req bool
|
|
2216
|
+
:param str entity_type: Entity Group type (required)
|
|
2217
|
+
:param str entity_id: A string value representing the entity id. For example, '784f394c-42b6-435a-983c-b7beff2784f9' (required)
|
|
2218
|
+
:return: list[EntityGroupId]
|
|
2219
|
+
If the method is called asynchronously,
|
|
2220
|
+
returns the request thread.
|
|
2221
|
+
"""
|
|
2222
|
+
kwargs['_return_http_data_only'] = True
|
|
2223
|
+
if kwargs.get('async_req'):
|
|
2224
|
+
return self.get_entity_groups_for_entity_using_get_with_http_info(entity_type, entity_id, **kwargs) # noqa: E501
|
|
2225
|
+
else:
|
|
2226
|
+
(data) = self.get_entity_groups_for_entity_using_get_with_http_info(entity_type, entity_id, **kwargs) # noqa: E501
|
|
2227
|
+
return data
|
|
2228
|
+
|
|
2229
|
+
def get_entity_groups_for_entity_using_get_with_http_info(self, entity_type, entity_id, **kwargs): # noqa: E501
|
|
2230
|
+
"""Get Entity Groups by Entity Id (getEntityGroupsForEntity) # noqa: E501
|
|
2231
|
+
|
|
2232
|
+
Returns a list of groups that contain the specified Entity Id. For example, all device groups that contain specific device. The list always contain at least one element - special group 'All'.You can specify parameters to filter the results. The result is wrapped with PageData object that allows you to iterate over result set using pagination. See the 'Model' tab of the Response Class for more details. Available for users with 'TENANT_ADMIN' or 'CUSTOMER_USER' authority. Security check is performed to verify that the user has 'READ' permission for the entity (entities). # noqa: E501
|
|
2233
|
+
This method makes a synchronous HTTP request by default. To make an
|
|
2234
|
+
asynchronous HTTP request, please pass async_req=True
|
|
2235
|
+
>>> thread = api.get_entity_groups_for_entity_using_get_with_http_info(entity_type, entity_id, async_req=True)
|
|
2236
|
+
>>> result = thread.get()
|
|
2237
|
+
|
|
2238
|
+
:param async_req bool
|
|
2239
|
+
:param str entity_type: Entity Group type (required)
|
|
2240
|
+
:param str entity_id: A string value representing the entity id. For example, '784f394c-42b6-435a-983c-b7beff2784f9' (required)
|
|
2241
|
+
:return: list[EntityGroupId]
|
|
2242
|
+
If the method is called asynchronously,
|
|
2243
|
+
returns the request thread.
|
|
2244
|
+
"""
|
|
2245
|
+
|
|
2246
|
+
all_params = ['entity_type', 'entity_id'] # noqa: E501
|
|
2247
|
+
all_params.append('async_req')
|
|
2248
|
+
all_params.append('_return_http_data_only')
|
|
2249
|
+
all_params.append('_preload_content')
|
|
2250
|
+
all_params.append('_request_timeout')
|
|
2251
|
+
|
|
2252
|
+
params = locals()
|
|
2253
|
+
for key, val in six.iteritems(params['kwargs']):
|
|
2254
|
+
if key not in all_params:
|
|
2255
|
+
raise TypeError(
|
|
2256
|
+
"Got an unexpected keyword argument '%s'"
|
|
2257
|
+
" to method get_entity_groups_for_entity_using_get" % key
|
|
2258
|
+
)
|
|
2259
|
+
params[key] = val
|
|
2260
|
+
del params['kwargs']
|
|
2261
|
+
# verify the required parameter 'entity_type' is set
|
|
2262
|
+
if ('entity_type' not in params or
|
|
2263
|
+
params['entity_type'] is None):
|
|
2264
|
+
raise ValueError("Missing the required parameter `entity_type` when calling `get_entity_groups_for_entity_using_get`") # noqa: E501
|
|
2265
|
+
# verify the required parameter 'entity_id' is set
|
|
2266
|
+
if ('entity_id' not in params or
|
|
2267
|
+
params['entity_id'] is None):
|
|
2268
|
+
raise ValueError("Missing the required parameter `entity_id` when calling `get_entity_groups_for_entity_using_get`") # noqa: E501
|
|
2269
|
+
|
|
2270
|
+
collection_formats = {}
|
|
2271
|
+
|
|
2272
|
+
path_params = {}
|
|
2273
|
+
if 'entity_type' in params:
|
|
2274
|
+
path_params['entityType'] = params['entity_type'] # noqa: E501
|
|
2275
|
+
if 'entity_id' in params:
|
|
2276
|
+
path_params['entityId'] = params['entity_id'] # noqa: E501
|
|
2277
|
+
|
|
2278
|
+
query_params = []
|
|
2279
|
+
|
|
2280
|
+
header_params = {}
|
|
2281
|
+
|
|
2282
|
+
form_params = []
|
|
2283
|
+
local_var_files = {}
|
|
2284
|
+
|
|
2285
|
+
body_params = None
|
|
2286
|
+
# HTTP header `Accept`
|
|
2287
|
+
header_params['Accept'] = self.api_client.select_header_accept(
|
|
2288
|
+
['application/json']) # noqa: E501
|
|
2289
|
+
|
|
2290
|
+
# Authentication setting
|
|
2291
|
+
auth_settings = ['X-Authorization'] # noqa: E501
|
|
2292
|
+
|
|
2293
|
+
return self.api_client.call_api(
|
|
2294
|
+
'/api/entityGroups/{entityType}/{entityId}', 'GET',
|
|
2295
|
+
path_params,
|
|
2296
|
+
query_params,
|
|
2297
|
+
header_params,
|
|
2298
|
+
body=body_params,
|
|
2299
|
+
post_params=form_params,
|
|
2300
|
+
files=local_var_files,
|
|
2301
|
+
response_type='list[EntityGroupId]', # noqa: E501
|
|
2302
|
+
auth_settings=auth_settings,
|
|
2303
|
+
async_req=params.get('async_req'),
|
|
2304
|
+
_return_http_data_only=params.get('_return_http_data_only'),
|
|
2305
|
+
_preload_content=params.get('_preload_content', True),
|
|
2306
|
+
_request_timeout=params.get('_request_timeout'),
|
|
2307
|
+
collection_formats=collection_formats)
|
|
2308
|
+
|
|
2309
|
+
def get_entity_groups_hierarchy_by_owner_and_type_and_page_link_using_get(self, owner_type, owner_id, group_type, page_size, page, **kwargs): # noqa: E501
|
|
2310
|
+
"""Get Entity Groups for all owners starting from specified than ending with owner of current user (getEntityGroupsHierarchyByOwnerAndTypeAndPageLink) # noqa: E501
|
|
2311
|
+
|
|
2312
|
+
Returns a page of Entity Group objects based on the provided Owner Id and Entity Type and Page Link. Entity group allows you to group multiple entities of the same entity type (Device, Asset, Customer, User, Dashboard, etc). Entity Group always have an owner - particular Tenant or Customer. Each entity may belong to multiple groups simultaneously.You can specify parameters to filter the results. The result is wrapped with PageData object that allows you to iterate over result set using pagination. See the 'Model' tab of the Response Class for more details. Available for users with 'TENANT_ADMIN' or 'CUSTOMER_USER' authority. Security check is performed to verify that the user has 'READ' permission for specified group. # noqa: E501
|
|
2313
|
+
This method makes a synchronous HTTP request by default. To make an
|
|
2314
|
+
asynchronous HTTP request, please pass async_req=True
|
|
2315
|
+
>>> thread = api.get_entity_groups_hierarchy_by_owner_and_type_and_page_link_using_get(owner_type, owner_id, group_type, page_size, page, async_req=True)
|
|
2316
|
+
>>> result = thread.get()
|
|
2317
|
+
|
|
2318
|
+
:param async_req bool
|
|
2319
|
+
:param str owner_type: Tenant or Customer (required)
|
|
2320
|
+
:param str owner_id: A string value representing the Tenant or Customer id (required)
|
|
2321
|
+
:param str group_type: Entity Group type (required)
|
|
2322
|
+
:param int page_size: Maximum amount of entities in a one page (required)
|
|
2323
|
+
:param int page: Sequence number of page starting from 0 (required)
|
|
2324
|
+
:param str text_search: The case insensitive 'startsWith' filter based on the entity group name.
|
|
2325
|
+
:param str sort_property: Property of entity to sort by
|
|
2326
|
+
:param str sort_order: Sort order. ASC (ASCENDING) or DESC (DESCENDING)
|
|
2327
|
+
:return: PageDataEntityGroupInfo
|
|
2328
|
+
If the method is called asynchronously,
|
|
2329
|
+
returns the request thread.
|
|
2330
|
+
"""
|
|
2331
|
+
kwargs['_return_http_data_only'] = True
|
|
2332
|
+
if kwargs.get('async_req'):
|
|
2333
|
+
return self.get_entity_groups_hierarchy_by_owner_and_type_and_page_link_using_get_with_http_info(owner_type, owner_id, group_type, page_size, page, **kwargs) # noqa: E501
|
|
2334
|
+
else:
|
|
2335
|
+
(data) = self.get_entity_groups_hierarchy_by_owner_and_type_and_page_link_using_get_with_http_info(owner_type, owner_id, group_type, page_size, page, **kwargs) # noqa: E501
|
|
2336
|
+
return data
|
|
2337
|
+
|
|
2338
|
+
def get_entity_groups_hierarchy_by_owner_and_type_and_page_link_using_get_with_http_info(self, owner_type, owner_id, group_type, page_size, page, **kwargs): # noqa: E501
|
|
2339
|
+
"""Get Entity Groups for all owners starting from specified than ending with owner of current user (getEntityGroupsHierarchyByOwnerAndTypeAndPageLink) # noqa: E501
|
|
2340
|
+
|
|
2341
|
+
Returns a page of Entity Group objects based on the provided Owner Id and Entity Type and Page Link. Entity group allows you to group multiple entities of the same entity type (Device, Asset, Customer, User, Dashboard, etc). Entity Group always have an owner - particular Tenant or Customer. Each entity may belong to multiple groups simultaneously.You can specify parameters to filter the results. The result is wrapped with PageData object that allows you to iterate over result set using pagination. See the 'Model' tab of the Response Class for more details. Available for users with 'TENANT_ADMIN' or 'CUSTOMER_USER' authority. Security check is performed to verify that the user has 'READ' permission for specified group. # noqa: E501
|
|
2342
|
+
This method makes a synchronous HTTP request by default. To make an
|
|
2343
|
+
asynchronous HTTP request, please pass async_req=True
|
|
2344
|
+
>>> thread = api.get_entity_groups_hierarchy_by_owner_and_type_and_page_link_using_get_with_http_info(owner_type, owner_id, group_type, page_size, page, async_req=True)
|
|
2345
|
+
>>> result = thread.get()
|
|
2346
|
+
|
|
2347
|
+
:param async_req bool
|
|
2348
|
+
:param str owner_type: Tenant or Customer (required)
|
|
2349
|
+
:param str owner_id: A string value representing the Tenant or Customer id (required)
|
|
2350
|
+
:param str group_type: Entity Group type (required)
|
|
2351
|
+
:param int page_size: Maximum amount of entities in a one page (required)
|
|
2352
|
+
:param int page: Sequence number of page starting from 0 (required)
|
|
2353
|
+
:param str text_search: The case insensitive 'startsWith' filter based on the entity group name.
|
|
2354
|
+
:param str sort_property: Property of entity to sort by
|
|
2355
|
+
:param str sort_order: Sort order. ASC (ASCENDING) or DESC (DESCENDING)
|
|
2356
|
+
:return: PageDataEntityGroupInfo
|
|
2357
|
+
If the method is called asynchronously,
|
|
2358
|
+
returns the request thread.
|
|
2359
|
+
"""
|
|
2360
|
+
|
|
2361
|
+
all_params = ['owner_type', 'owner_id', 'group_type', 'page_size', 'page', 'text_search', 'sort_property', 'sort_order'] # noqa: E501
|
|
2362
|
+
all_params.append('async_req')
|
|
2363
|
+
all_params.append('_return_http_data_only')
|
|
2364
|
+
all_params.append('_preload_content')
|
|
2365
|
+
all_params.append('_request_timeout')
|
|
2366
|
+
|
|
2367
|
+
params = locals()
|
|
2368
|
+
for key, val in six.iteritems(params['kwargs']):
|
|
2369
|
+
if key not in all_params:
|
|
2370
|
+
raise TypeError(
|
|
2371
|
+
"Got an unexpected keyword argument '%s'"
|
|
2372
|
+
" to method get_entity_groups_hierarchy_by_owner_and_type_and_page_link_using_get" % key
|
|
2373
|
+
)
|
|
2374
|
+
params[key] = val
|
|
2375
|
+
del params['kwargs']
|
|
2376
|
+
# verify the required parameter 'owner_type' is set
|
|
2377
|
+
if ('owner_type' not in params or
|
|
2378
|
+
params['owner_type'] is None):
|
|
2379
|
+
raise ValueError("Missing the required parameter `owner_type` when calling `get_entity_groups_hierarchy_by_owner_and_type_and_page_link_using_get`") # noqa: E501
|
|
2380
|
+
# verify the required parameter 'owner_id' is set
|
|
2381
|
+
if ('owner_id' not in params or
|
|
2382
|
+
params['owner_id'] is None):
|
|
2383
|
+
raise ValueError("Missing the required parameter `owner_id` when calling `get_entity_groups_hierarchy_by_owner_and_type_and_page_link_using_get`") # noqa: E501
|
|
2384
|
+
# verify the required parameter 'group_type' is set
|
|
2385
|
+
if ('group_type' not in params or
|
|
2386
|
+
params['group_type'] is None):
|
|
2387
|
+
raise ValueError("Missing the required parameter `group_type` when calling `get_entity_groups_hierarchy_by_owner_and_type_and_page_link_using_get`") # noqa: E501
|
|
2388
|
+
# verify the required parameter 'page_size' is set
|
|
2389
|
+
if ('page_size' not in params or
|
|
2390
|
+
params['page_size'] is None):
|
|
2391
|
+
raise ValueError("Missing the required parameter `page_size` when calling `get_entity_groups_hierarchy_by_owner_and_type_and_page_link_using_get`") # noqa: E501
|
|
2392
|
+
# verify the required parameter 'page' is set
|
|
2393
|
+
if ('page' not in params or
|
|
2394
|
+
params['page'] is None):
|
|
2395
|
+
raise ValueError("Missing the required parameter `page` when calling `get_entity_groups_hierarchy_by_owner_and_type_and_page_link_using_get`") # noqa: E501
|
|
2396
|
+
|
|
2397
|
+
collection_formats = {}
|
|
2398
|
+
|
|
2399
|
+
path_params = {}
|
|
2400
|
+
if 'owner_type' in params:
|
|
2401
|
+
path_params['ownerType'] = params['owner_type'] # noqa: E501
|
|
2402
|
+
if 'owner_id' in params:
|
|
2403
|
+
path_params['ownerId'] = params['owner_id'] # noqa: E501
|
|
2404
|
+
if 'group_type' in params:
|
|
2405
|
+
path_params['groupType'] = params['group_type'] # noqa: E501
|
|
2406
|
+
|
|
2407
|
+
query_params = []
|
|
2408
|
+
if 'page_size' in params:
|
|
2409
|
+
query_params.append(('pageSize', params['page_size'])) # noqa: E501
|
|
2410
|
+
if 'page' in params:
|
|
2411
|
+
query_params.append(('page', params['page'])) # noqa: E501
|
|
2412
|
+
if 'text_search' in params:
|
|
2413
|
+
query_params.append(('textSearch', params['text_search'])) # noqa: E501
|
|
2414
|
+
if 'sort_property' in params:
|
|
2415
|
+
query_params.append(('sortProperty', params['sort_property'])) # noqa: E501
|
|
2416
|
+
if 'sort_order' in params:
|
|
2417
|
+
query_params.append(('sortOrder', params['sort_order'])) # noqa: E501
|
|
2418
|
+
|
|
2419
|
+
header_params = {}
|
|
2420
|
+
|
|
2421
|
+
form_params = []
|
|
2422
|
+
local_var_files = {}
|
|
2423
|
+
|
|
2424
|
+
body_params = None
|
|
2425
|
+
# HTTP header `Accept`
|
|
2426
|
+
header_params['Accept'] = self.api_client.select_header_accept(
|
|
2427
|
+
['application/json']) # noqa: E501
|
|
2428
|
+
|
|
2429
|
+
# Authentication setting
|
|
2430
|
+
auth_settings = ['X-Authorization'] # noqa: E501
|
|
2431
|
+
|
|
2432
|
+
return self.api_client.call_api(
|
|
2433
|
+
'/api/entityGroupsHierarchy/{ownerType}/{ownerId}/{groupType}{?page,pageSize,sortOrder,sortProperty,textSearch}', 'GET',
|
|
2434
|
+
path_params,
|
|
2435
|
+
query_params,
|
|
2436
|
+
header_params,
|
|
2437
|
+
body=body_params,
|
|
2438
|
+
post_params=form_params,
|
|
2439
|
+
files=local_var_files,
|
|
2440
|
+
response_type='PageDataEntityGroupInfo', # noqa: E501
|
|
2441
|
+
auth_settings=auth_settings,
|
|
2442
|
+
async_req=params.get('async_req'),
|
|
2443
|
+
_return_http_data_only=params.get('_return_http_data_only'),
|
|
2444
|
+
_preload_content=params.get('_preload_content', True),
|
|
2445
|
+
_request_timeout=params.get('_request_timeout'),
|
|
2446
|
+
collection_formats=collection_formats)
|
|
2447
|
+
|
|
2448
|
+
def get_group_entity_using_get(self, entity_group_id, entity_id, **kwargs): # noqa: E501
|
|
2449
|
+
"""Get Group Entity (getGroupEntity) # noqa: E501
|
|
2450
|
+
|
|
2451
|
+
Fetch the Short Entity View object based on the group and entity id. Short Entity View object contains the entity id and number of fields (attributes, telemetry, etc). List of those fields is configurable and defined in the group configuration. Available for users with 'TENANT_ADMIN' or 'CUSTOMER_USER' authority. Security check is performed to verify that the user has 'READ' permission for specified group. # noqa: E501
|
|
2452
|
+
This method makes a synchronous HTTP request by default. To make an
|
|
2453
|
+
asynchronous HTTP request, please pass async_req=True
|
|
2454
|
+
>>> thread = api.get_group_entity_using_get(entity_group_id, entity_id, async_req=True)
|
|
2455
|
+
>>> result = thread.get()
|
|
2456
|
+
|
|
2457
|
+
:param async_req bool
|
|
2458
|
+
:param str entity_group_id: A string value representing the Entity Group Id. For example, '784f394c-42b6-435a-983c-b7beff2784f9' (required)
|
|
2459
|
+
:param str entity_id: A string value representing the entity id. For example, '784f394c-42b6-435a-983c-b7beff2784f9' (required)
|
|
2460
|
+
:return: ShortEntityView
|
|
2461
|
+
If the method is called asynchronously,
|
|
2462
|
+
returns the request thread.
|
|
2463
|
+
"""
|
|
2464
|
+
kwargs['_return_http_data_only'] = True
|
|
2465
|
+
if kwargs.get('async_req'):
|
|
2466
|
+
return self.get_group_entity_using_get_with_http_info(entity_group_id, entity_id, **kwargs) # noqa: E501
|
|
2467
|
+
else:
|
|
2468
|
+
(data) = self.get_group_entity_using_get_with_http_info(entity_group_id, entity_id, **kwargs) # noqa: E501
|
|
2469
|
+
return data
|
|
2470
|
+
|
|
2471
|
+
def get_group_entity_using_get_with_http_info(self, entity_group_id, entity_id, **kwargs): # noqa: E501
|
|
2472
|
+
"""Get Group Entity (getGroupEntity) # noqa: E501
|
|
2473
|
+
|
|
2474
|
+
Fetch the Short Entity View object based on the group and entity id. Short Entity View object contains the entity id and number of fields (attributes, telemetry, etc). List of those fields is configurable and defined in the group configuration. Available for users with 'TENANT_ADMIN' or 'CUSTOMER_USER' authority. Security check is performed to verify that the user has 'READ' permission for specified group. # noqa: E501
|
|
2475
|
+
This method makes a synchronous HTTP request by default. To make an
|
|
2476
|
+
asynchronous HTTP request, please pass async_req=True
|
|
2477
|
+
>>> thread = api.get_group_entity_using_get_with_http_info(entity_group_id, entity_id, async_req=True)
|
|
2478
|
+
>>> result = thread.get()
|
|
2479
|
+
|
|
2480
|
+
:param async_req bool
|
|
2481
|
+
:param str entity_group_id: A string value representing the Entity Group Id. For example, '784f394c-42b6-435a-983c-b7beff2784f9' (required)
|
|
2482
|
+
:param str entity_id: A string value representing the entity id. For example, '784f394c-42b6-435a-983c-b7beff2784f9' (required)
|
|
2483
|
+
:return: ShortEntityView
|
|
2484
|
+
If the method is called asynchronously,
|
|
2485
|
+
returns the request thread.
|
|
2486
|
+
"""
|
|
2487
|
+
|
|
2488
|
+
all_params = ['entity_group_id', 'entity_id'] # noqa: E501
|
|
2489
|
+
all_params.append('async_req')
|
|
2490
|
+
all_params.append('_return_http_data_only')
|
|
2491
|
+
all_params.append('_preload_content')
|
|
2492
|
+
all_params.append('_request_timeout')
|
|
2493
|
+
|
|
2494
|
+
params = locals()
|
|
2495
|
+
for key, val in six.iteritems(params['kwargs']):
|
|
2496
|
+
if key not in all_params:
|
|
2497
|
+
raise TypeError(
|
|
2498
|
+
"Got an unexpected keyword argument '%s'"
|
|
2499
|
+
" to method get_group_entity_using_get" % key
|
|
2500
|
+
)
|
|
2501
|
+
params[key] = val
|
|
2502
|
+
del params['kwargs']
|
|
2503
|
+
# verify the required parameter 'entity_group_id' is set
|
|
2504
|
+
if ('entity_group_id' not in params or
|
|
2505
|
+
params['entity_group_id'] is None):
|
|
2506
|
+
raise ValueError("Missing the required parameter `entity_group_id` when calling `get_group_entity_using_get`") # noqa: E501
|
|
2507
|
+
# verify the required parameter 'entity_id' is set
|
|
2508
|
+
if ('entity_id' not in params or
|
|
2509
|
+
params['entity_id'] is None):
|
|
2510
|
+
raise ValueError("Missing the required parameter `entity_id` when calling `get_group_entity_using_get`") # noqa: E501
|
|
2511
|
+
|
|
2512
|
+
collection_formats = {}
|
|
2513
|
+
|
|
2514
|
+
path_params = {}
|
|
2515
|
+
if 'entity_group_id' in params:
|
|
2516
|
+
path_params['entityGroupId'] = params['entity_group_id'] # noqa: E501
|
|
2517
|
+
if 'entity_id' in params:
|
|
2518
|
+
path_params['entityId'] = params['entity_id'] # noqa: E501
|
|
2519
|
+
|
|
2520
|
+
query_params = []
|
|
2521
|
+
|
|
2522
|
+
header_params = {}
|
|
2523
|
+
|
|
2524
|
+
form_params = []
|
|
2525
|
+
local_var_files = {}
|
|
2526
|
+
|
|
2527
|
+
body_params = None
|
|
2528
|
+
# HTTP header `Accept`
|
|
2529
|
+
header_params['Accept'] = self.api_client.select_header_accept(
|
|
2530
|
+
['application/json']) # noqa: E501
|
|
2531
|
+
|
|
2532
|
+
# Authentication setting
|
|
2533
|
+
auth_settings = ['X-Authorization'] # noqa: E501
|
|
2534
|
+
|
|
2535
|
+
return self.api_client.call_api(
|
|
2536
|
+
'/api/entityGroup/{entityGroupId}/{entityId}', 'GET',
|
|
2537
|
+
path_params,
|
|
2538
|
+
query_params,
|
|
2539
|
+
header_params,
|
|
2540
|
+
body=body_params,
|
|
2541
|
+
post_params=form_params,
|
|
2542
|
+
files=local_var_files,
|
|
2543
|
+
response_type='ShortEntityView', # noqa: E501
|
|
2544
|
+
auth_settings=auth_settings,
|
|
2545
|
+
async_req=params.get('async_req'),
|
|
2546
|
+
_return_http_data_only=params.get('_return_http_data_only'),
|
|
2547
|
+
_preload_content=params.get('_preload_content', True),
|
|
2548
|
+
_request_timeout=params.get('_request_timeout'),
|
|
2549
|
+
collection_formats=collection_formats)
|
|
2550
|
+
|
|
2551
|
+
def get_owner_info_using_get(self, owner_type, owner_id, **kwargs): # noqa: E501
|
|
2552
|
+
"""Get Owner Info (getOwnerInfo) # noqa: E501
|
|
2553
|
+
|
|
2554
|
+
Fetch the owner info (tenant or customer) presented as Entity Info object based on the provided owner Id. Available for users with 'TENANT_ADMIN' or 'CUSTOMER_USER' authority. Security check is performed to verify that the user has 'READ' permission for specified group. # noqa: E501
|
|
2555
|
+
This method makes a synchronous HTTP request by default. To make an
|
|
2556
|
+
asynchronous HTTP request, please pass async_req=True
|
|
2557
|
+
>>> thread = api.get_owner_info_using_get(owner_type, owner_id, async_req=True)
|
|
2558
|
+
>>> result = thread.get()
|
|
2559
|
+
|
|
2560
|
+
:param async_req bool
|
|
2561
|
+
:param str owner_type: Tenant or Customer (required)
|
|
2562
|
+
:param str owner_id: A string value representing the Tenant or Customer id (required)
|
|
2563
|
+
:return: EntityInfo
|
|
2564
|
+
If the method is called asynchronously,
|
|
2565
|
+
returns the request thread.
|
|
2566
|
+
"""
|
|
2567
|
+
kwargs['_return_http_data_only'] = True
|
|
2568
|
+
if kwargs.get('async_req'):
|
|
2569
|
+
return self.get_owner_info_using_get_with_http_info(owner_type, owner_id, **kwargs) # noqa: E501
|
|
2570
|
+
else:
|
|
2571
|
+
(data) = self.get_owner_info_using_get_with_http_info(owner_type, owner_id, **kwargs) # noqa: E501
|
|
2572
|
+
return data
|
|
2573
|
+
|
|
2574
|
+
def get_owner_info_using_get_with_http_info(self, owner_type, owner_id, **kwargs): # noqa: E501
|
|
2575
|
+
"""Get Owner Info (getOwnerInfo) # noqa: E501
|
|
2576
|
+
|
|
2577
|
+
Fetch the owner info (tenant or customer) presented as Entity Info object based on the provided owner Id. Available for users with 'TENANT_ADMIN' or 'CUSTOMER_USER' authority. Security check is performed to verify that the user has 'READ' permission for specified group. # noqa: E501
|
|
2578
|
+
This method makes a synchronous HTTP request by default. To make an
|
|
2579
|
+
asynchronous HTTP request, please pass async_req=True
|
|
2580
|
+
>>> thread = api.get_owner_info_using_get_with_http_info(owner_type, owner_id, async_req=True)
|
|
2581
|
+
>>> result = thread.get()
|
|
2582
|
+
|
|
2583
|
+
:param async_req bool
|
|
2584
|
+
:param str owner_type: Tenant or Customer (required)
|
|
2585
|
+
:param str owner_id: A string value representing the Tenant or Customer id (required)
|
|
2586
|
+
:return: EntityInfo
|
|
2587
|
+
If the method is called asynchronously,
|
|
2588
|
+
returns the request thread.
|
|
2589
|
+
"""
|
|
2590
|
+
|
|
2591
|
+
all_params = ['owner_type', 'owner_id'] # noqa: E501
|
|
2592
|
+
all_params.append('async_req')
|
|
2593
|
+
all_params.append('_return_http_data_only')
|
|
2594
|
+
all_params.append('_preload_content')
|
|
2595
|
+
all_params.append('_request_timeout')
|
|
2596
|
+
|
|
2597
|
+
params = locals()
|
|
2598
|
+
for key, val in six.iteritems(params['kwargs']):
|
|
2599
|
+
if key not in all_params:
|
|
2600
|
+
raise TypeError(
|
|
2601
|
+
"Got an unexpected keyword argument '%s'"
|
|
2602
|
+
" to method get_owner_info_using_get" % key
|
|
2603
|
+
)
|
|
2604
|
+
params[key] = val
|
|
2605
|
+
del params['kwargs']
|
|
2606
|
+
# verify the required parameter 'owner_type' is set
|
|
2607
|
+
if ('owner_type' not in params or
|
|
2608
|
+
params['owner_type'] is None):
|
|
2609
|
+
raise ValueError("Missing the required parameter `owner_type` when calling `get_owner_info_using_get`") # noqa: E501
|
|
2610
|
+
# verify the required parameter 'owner_id' is set
|
|
2611
|
+
if ('owner_id' not in params or
|
|
2612
|
+
params['owner_id'] is None):
|
|
2613
|
+
raise ValueError("Missing the required parameter `owner_id` when calling `get_owner_info_using_get`") # noqa: E501
|
|
2614
|
+
|
|
2615
|
+
collection_formats = {}
|
|
2616
|
+
|
|
2617
|
+
path_params = {}
|
|
2618
|
+
if 'owner_type' in params:
|
|
2619
|
+
path_params['ownerType'] = params['owner_type'] # noqa: E501
|
|
2620
|
+
if 'owner_id' in params:
|
|
2621
|
+
path_params['ownerId'] = params['owner_id'] # noqa: E501
|
|
2622
|
+
|
|
2623
|
+
query_params = []
|
|
2624
|
+
|
|
2625
|
+
header_params = {}
|
|
2626
|
+
|
|
2627
|
+
form_params = []
|
|
2628
|
+
local_var_files = {}
|
|
2629
|
+
|
|
2630
|
+
body_params = None
|
|
2631
|
+
# HTTP header `Accept`
|
|
2632
|
+
header_params['Accept'] = self.api_client.select_header_accept(
|
|
2633
|
+
['application/json']) # noqa: E501
|
|
2634
|
+
|
|
2635
|
+
# Authentication setting
|
|
2636
|
+
auth_settings = ['X-Authorization'] # noqa: E501
|
|
2637
|
+
|
|
2638
|
+
return self.api_client.call_api(
|
|
2639
|
+
'/api/ownerInfo/{ownerType}/{ownerId}', 'GET',
|
|
2640
|
+
path_params,
|
|
2641
|
+
query_params,
|
|
2642
|
+
header_params,
|
|
2643
|
+
body=body_params,
|
|
2644
|
+
post_params=form_params,
|
|
2645
|
+
files=local_var_files,
|
|
2646
|
+
response_type='EntityInfo', # noqa: E501
|
|
2647
|
+
auth_settings=auth_settings,
|
|
2648
|
+
async_req=params.get('async_req'),
|
|
2649
|
+
_return_http_data_only=params.get('_return_http_data_only'),
|
|
2650
|
+
_preload_content=params.get('_preload_content', True),
|
|
2651
|
+
_request_timeout=params.get('_request_timeout'),
|
|
2652
|
+
collection_formats=collection_formats)
|
|
2653
|
+
|
|
2654
|
+
def get_owner_infos_using_get(self, page_size, page, **kwargs): # noqa: E501
|
|
2655
|
+
"""Get Owner Infos (getOwnerInfos) # noqa: E501
|
|
2656
|
+
|
|
2657
|
+
Provides a rage view of Customers that the current user has READ access to. If the current user is Tenant administrator, the result set also contains the tenant. The call is designed for the UI auto-complete component to show tenant and all possible Customers that the user may select to change the owner of the particular entity or entity group. Available for users with 'TENANT_ADMIN' or 'CUSTOMER_USER' authority. Security check is performed to verify that the user has 'READ' permission for the entity (entities). # noqa: E501
|
|
2658
|
+
This method makes a synchronous HTTP request by default. To make an
|
|
2659
|
+
asynchronous HTTP request, please pass async_req=True
|
|
2660
|
+
>>> thread = api.get_owner_infos_using_get(page_size, page, async_req=True)
|
|
2661
|
+
>>> result = thread.get()
|
|
2662
|
+
|
|
2663
|
+
:param async_req bool
|
|
2664
|
+
:param int page_size: Maximum amount of entities in a one page (required)
|
|
2665
|
+
:param int page: Sequence number of page starting from 0 (required)
|
|
2666
|
+
:param str text_search: The case insensitive 'startsWith' filter based on the entity group name.
|
|
2667
|
+
:param str sort_property: Property of entity to sort by
|
|
2668
|
+
:param str sort_order: Sort order. ASC (ASCENDING) or DESC (DESCENDING)
|
|
2669
|
+
:return: PageDataEntityInfo
|
|
2670
|
+
If the method is called asynchronously,
|
|
2671
|
+
returns the request thread.
|
|
2672
|
+
"""
|
|
2673
|
+
kwargs['_return_http_data_only'] = True
|
|
2674
|
+
if kwargs.get('async_req'):
|
|
2675
|
+
return self.get_owner_infos_using_get_with_http_info(page_size, page, **kwargs) # noqa: E501
|
|
2676
|
+
else:
|
|
2677
|
+
(data) = self.get_owner_infos_using_get_with_http_info(page_size, page, **kwargs) # noqa: E501
|
|
2678
|
+
return data
|
|
2679
|
+
|
|
2680
|
+
def get_owner_infos_using_get_with_http_info(self, page_size, page, **kwargs): # noqa: E501
|
|
2681
|
+
"""Get Owner Infos (getOwnerInfos) # noqa: E501
|
|
2682
|
+
|
|
2683
|
+
Provides a rage view of Customers that the current user has READ access to. If the current user is Tenant administrator, the result set also contains the tenant. The call is designed for the UI auto-complete component to show tenant and all possible Customers that the user may select to change the owner of the particular entity or entity group. Available for users with 'TENANT_ADMIN' or 'CUSTOMER_USER' authority. Security check is performed to verify that the user has 'READ' permission for the entity (entities). # noqa: E501
|
|
2684
|
+
This method makes a synchronous HTTP request by default. To make an
|
|
2685
|
+
asynchronous HTTP request, please pass async_req=True
|
|
2686
|
+
>>> thread = api.get_owner_infos_using_get_with_http_info(page_size, page, async_req=True)
|
|
2687
|
+
>>> result = thread.get()
|
|
2688
|
+
|
|
2689
|
+
:param async_req bool
|
|
2690
|
+
:param int page_size: Maximum amount of entities in a one page (required)
|
|
2691
|
+
:param int page: Sequence number of page starting from 0 (required)
|
|
2692
|
+
:param str text_search: The case insensitive 'startsWith' filter based on the entity group name.
|
|
2693
|
+
:param str sort_property: Property of entity to sort by
|
|
2694
|
+
:param str sort_order: Sort order. ASC (ASCENDING) or DESC (DESCENDING)
|
|
2695
|
+
:return: PageDataEntityInfo
|
|
2696
|
+
If the method is called asynchronously,
|
|
2697
|
+
returns the request thread.
|
|
2698
|
+
"""
|
|
2699
|
+
|
|
2700
|
+
all_params = ['page_size', 'page', 'text_search', 'sort_property', 'sort_order'] # noqa: E501
|
|
2701
|
+
all_params.append('async_req')
|
|
2702
|
+
all_params.append('_return_http_data_only')
|
|
2703
|
+
all_params.append('_preload_content')
|
|
2704
|
+
all_params.append('_request_timeout')
|
|
2705
|
+
|
|
2706
|
+
params = locals()
|
|
2707
|
+
for key, val in six.iteritems(params['kwargs']):
|
|
2708
|
+
if key not in all_params:
|
|
2709
|
+
raise TypeError(
|
|
2710
|
+
"Got an unexpected keyword argument '%s'"
|
|
2711
|
+
" to method get_owner_infos_using_get" % key
|
|
2712
|
+
)
|
|
2713
|
+
params[key] = val
|
|
2714
|
+
del params['kwargs']
|
|
2715
|
+
# verify the required parameter 'page_size' is set
|
|
2716
|
+
if ('page_size' not in params or
|
|
2717
|
+
params['page_size'] is None):
|
|
2718
|
+
raise ValueError("Missing the required parameter `page_size` when calling `get_owner_infos_using_get`") # noqa: E501
|
|
2719
|
+
# verify the required parameter 'page' is set
|
|
2720
|
+
if ('page' not in params or
|
|
2721
|
+
params['page'] is None):
|
|
2722
|
+
raise ValueError("Missing the required parameter `page` when calling `get_owner_infos_using_get`") # noqa: E501
|
|
2723
|
+
|
|
2724
|
+
collection_formats = {}
|
|
2725
|
+
|
|
2726
|
+
path_params = {}
|
|
2727
|
+
|
|
2728
|
+
query_params = []
|
|
2729
|
+
if 'page_size' in params:
|
|
2730
|
+
query_params.append(('pageSize', params['page_size'])) # noqa: E501
|
|
2731
|
+
if 'page' in params:
|
|
2732
|
+
query_params.append(('page', params['page'])) # noqa: E501
|
|
2733
|
+
if 'text_search' in params:
|
|
2734
|
+
query_params.append(('textSearch', params['text_search'])) # noqa: E501
|
|
2735
|
+
if 'sort_property' in params:
|
|
2736
|
+
query_params.append(('sortProperty', params['sort_property'])) # noqa: E501
|
|
2737
|
+
if 'sort_order' in params:
|
|
2738
|
+
query_params.append(('sortOrder', params['sort_order'])) # noqa: E501
|
|
2739
|
+
|
|
2740
|
+
header_params = {}
|
|
2741
|
+
|
|
2742
|
+
form_params = []
|
|
2743
|
+
local_var_files = {}
|
|
2744
|
+
|
|
2745
|
+
body_params = None
|
|
2746
|
+
# HTTP header `Accept`
|
|
2747
|
+
header_params['Accept'] = self.api_client.select_header_accept(
|
|
2748
|
+
['application/json']) # noqa: E501
|
|
2749
|
+
|
|
2750
|
+
# Authentication setting
|
|
2751
|
+
auth_settings = ['X-Authorization'] # noqa: E501
|
|
2752
|
+
|
|
2753
|
+
return self.api_client.call_api(
|
|
2754
|
+
'/api/ownerInfos{?page,pageSize,sortOrder,sortProperty,textSearch}', 'GET',
|
|
2755
|
+
path_params,
|
|
2756
|
+
query_params,
|
|
2757
|
+
header_params,
|
|
2758
|
+
body=body_params,
|
|
2759
|
+
post_params=form_params,
|
|
2760
|
+
files=local_var_files,
|
|
2761
|
+
response_type='PageDataEntityInfo', # noqa: E501
|
|
2762
|
+
auth_settings=auth_settings,
|
|
2763
|
+
async_req=params.get('async_req'),
|
|
2764
|
+
_return_http_data_only=params.get('_return_http_data_only'),
|
|
2765
|
+
_preload_content=params.get('_preload_content', True),
|
|
2766
|
+
_request_timeout=params.get('_request_timeout'),
|
|
2767
|
+
collection_formats=collection_formats)
|
|
2768
|
+
|
|
2769
|
+
def get_owners_using_get(self, page_size, page, **kwargs): # noqa: E501
|
|
2770
|
+
"""Get Owners (getOwners) # noqa: E501
|
|
2771
|
+
|
|
2772
|
+
Provides a rage view of Customers that the current user has READ access to. If the current user is Tenant administrator, the result set also contains the tenant. The call is designed for the UI auto-complete component to show tenant and all possible Customers that the user may select to change the owner of the particular entity or entity group. Available for users with 'TENANT_ADMIN' or 'CUSTOMER_USER' authority. Security check is performed to verify that the user has 'READ' permission for the entity (entities). # noqa: E501
|
|
2773
|
+
This method makes a synchronous HTTP request by default. To make an
|
|
2774
|
+
asynchronous HTTP request, please pass async_req=True
|
|
2775
|
+
>>> thread = api.get_owners_using_get(page_size, page, async_req=True)
|
|
2776
|
+
>>> result = thread.get()
|
|
2777
|
+
|
|
2778
|
+
:param async_req bool
|
|
2779
|
+
:param int page_size: Maximum amount of entities in a one page (required)
|
|
2780
|
+
:param int page: Sequence number of page starting from 0 (required)
|
|
2781
|
+
:param str text_search: The case insensitive 'startsWith' filter based on the entity group name.
|
|
2782
|
+
:param str sort_property: Property of entity to sort by
|
|
2783
|
+
:param str sort_order: Sort order. ASC (ASCENDING) or DESC (DESCENDING)
|
|
2784
|
+
:return: PageDataContactBasedobject
|
|
2785
|
+
If the method is called asynchronously,
|
|
2786
|
+
returns the request thread.
|
|
2787
|
+
"""
|
|
2788
|
+
kwargs['_return_http_data_only'] = True
|
|
2789
|
+
if kwargs.get('async_req'):
|
|
2790
|
+
return self.get_owners_using_get_with_http_info(page_size, page, **kwargs) # noqa: E501
|
|
2791
|
+
else:
|
|
2792
|
+
(data) = self.get_owners_using_get_with_http_info(page_size, page, **kwargs) # noqa: E501
|
|
2793
|
+
return data
|
|
2794
|
+
|
|
2795
|
+
def get_owners_using_get_with_http_info(self, page_size, page, **kwargs): # noqa: E501
|
|
2796
|
+
"""Get Owners (getOwners) # noqa: E501
|
|
2797
|
+
|
|
2798
|
+
Provides a rage view of Customers that the current user has READ access to. If the current user is Tenant administrator, the result set also contains the tenant. The call is designed for the UI auto-complete component to show tenant and all possible Customers that the user may select to change the owner of the particular entity or entity group. Available for users with 'TENANT_ADMIN' or 'CUSTOMER_USER' authority. Security check is performed to verify that the user has 'READ' permission for the entity (entities). # noqa: E501
|
|
2799
|
+
This method makes a synchronous HTTP request by default. To make an
|
|
2800
|
+
asynchronous HTTP request, please pass async_req=True
|
|
2801
|
+
>>> thread = api.get_owners_using_get_with_http_info(page_size, page, async_req=True)
|
|
2802
|
+
>>> result = thread.get()
|
|
2803
|
+
|
|
2804
|
+
:param async_req bool
|
|
2805
|
+
:param int page_size: Maximum amount of entities in a one page (required)
|
|
2806
|
+
:param int page: Sequence number of page starting from 0 (required)
|
|
2807
|
+
:param str text_search: The case insensitive 'startsWith' filter based on the entity group name.
|
|
2808
|
+
:param str sort_property: Property of entity to sort by
|
|
2809
|
+
:param str sort_order: Sort order. ASC (ASCENDING) or DESC (DESCENDING)
|
|
2810
|
+
:return: PageDataContactBasedobject
|
|
2811
|
+
If the method is called asynchronously,
|
|
2812
|
+
returns the request thread.
|
|
2813
|
+
"""
|
|
2814
|
+
|
|
2815
|
+
all_params = ['page_size', 'page', 'text_search', 'sort_property', 'sort_order'] # noqa: E501
|
|
2816
|
+
all_params.append('async_req')
|
|
2817
|
+
all_params.append('_return_http_data_only')
|
|
2818
|
+
all_params.append('_preload_content')
|
|
2819
|
+
all_params.append('_request_timeout')
|
|
2820
|
+
|
|
2821
|
+
params = locals()
|
|
2822
|
+
for key, val in six.iteritems(params['kwargs']):
|
|
2823
|
+
if key not in all_params:
|
|
2824
|
+
raise TypeError(
|
|
2825
|
+
"Got an unexpected keyword argument '%s'"
|
|
2826
|
+
" to method get_owners_using_get" % key
|
|
2827
|
+
)
|
|
2828
|
+
params[key] = val
|
|
2829
|
+
del params['kwargs']
|
|
2830
|
+
# verify the required parameter 'page_size' is set
|
|
2831
|
+
if ('page_size' not in params or
|
|
2832
|
+
params['page_size'] is None):
|
|
2833
|
+
raise ValueError("Missing the required parameter `page_size` when calling `get_owners_using_get`") # noqa: E501
|
|
2834
|
+
# verify the required parameter 'page' is set
|
|
2835
|
+
if ('page' not in params or
|
|
2836
|
+
params['page'] is None):
|
|
2837
|
+
raise ValueError("Missing the required parameter `page` when calling `get_owners_using_get`") # noqa: E501
|
|
2838
|
+
|
|
2839
|
+
collection_formats = {}
|
|
2840
|
+
|
|
2841
|
+
path_params = {}
|
|
2842
|
+
|
|
2843
|
+
query_params = []
|
|
2844
|
+
if 'page_size' in params:
|
|
2845
|
+
query_params.append(('pageSize', params['page_size'])) # noqa: E501
|
|
2846
|
+
if 'page' in params:
|
|
2847
|
+
query_params.append(('page', params['page'])) # noqa: E501
|
|
2848
|
+
if 'text_search' in params:
|
|
2849
|
+
query_params.append(('textSearch', params['text_search'])) # noqa: E501
|
|
2850
|
+
if 'sort_property' in params:
|
|
2851
|
+
query_params.append(('sortProperty', params['sort_property'])) # noqa: E501
|
|
2852
|
+
if 'sort_order' in params:
|
|
2853
|
+
query_params.append(('sortOrder', params['sort_order'])) # noqa: E501
|
|
2854
|
+
|
|
2855
|
+
header_params = {}
|
|
2856
|
+
|
|
2857
|
+
form_params = []
|
|
2858
|
+
local_var_files = {}
|
|
2859
|
+
|
|
2860
|
+
body_params = None
|
|
2861
|
+
# HTTP header `Accept`
|
|
2862
|
+
header_params['Accept'] = self.api_client.select_header_accept(
|
|
2863
|
+
['application/json']) # noqa: E501
|
|
2864
|
+
|
|
2865
|
+
# Authentication setting
|
|
2866
|
+
auth_settings = ['X-Authorization'] # noqa: E501
|
|
2867
|
+
|
|
2868
|
+
return self.api_client.call_api(
|
|
2869
|
+
'/api/owners{?page,pageSize,sortOrder,sortProperty,textSearch}', 'GET',
|
|
2870
|
+
path_params,
|
|
2871
|
+
query_params,
|
|
2872
|
+
header_params,
|
|
2873
|
+
body=body_params,
|
|
2874
|
+
post_params=form_params,
|
|
2875
|
+
files=local_var_files,
|
|
2876
|
+
response_type='PageDataContactBasedobject', # noqa: E501
|
|
2877
|
+
auth_settings=auth_settings,
|
|
2878
|
+
async_req=params.get('async_req'),
|
|
2879
|
+
_return_http_data_only=params.get('_return_http_data_only'),
|
|
2880
|
+
_preload_content=params.get('_preload_content', True),
|
|
2881
|
+
_request_timeout=params.get('_request_timeout'),
|
|
2882
|
+
collection_formats=collection_formats)
|
|
2883
|
+
|
|
2884
|
+
def get_shared_entity_group_entity_infos_by_type_and_page_link_using_get(self, group_type, page_size, page, **kwargs): # noqa: E501
|
|
2885
|
+
"""Get Shared Entity Group Entity Infos by entity type and page link (getSharedEntityGroupEntityInfosByTypeAndPageLink) # noqa: E501
|
|
2886
|
+
|
|
2887
|
+
Returns a page of Shared Entity Group Entity Info objects based on the provided Entity Type and Page Link. Entity Info is a lightweight object that contains only id and name of the entity group. You can specify parameters to filter the results. The result is wrapped with PageData object that allows you to iterate over result set using pagination. See the 'Model' tab of the Response Class for more details. Available for users with 'TENANT_ADMIN' or 'CUSTOMER_USER' authority. Security check is performed to verify that the user has 'READ' permission for specified group. # noqa: E501
|
|
2888
|
+
This method makes a synchronous HTTP request by default. To make an
|
|
2889
|
+
asynchronous HTTP request, please pass async_req=True
|
|
2890
|
+
>>> thread = api.get_shared_entity_group_entity_infos_by_type_and_page_link_using_get(group_type, page_size, page, async_req=True)
|
|
2891
|
+
>>> result = thread.get()
|
|
2892
|
+
|
|
2893
|
+
:param async_req bool
|
|
2894
|
+
:param str group_type: Entity Group type (required)
|
|
2895
|
+
:param int page_size: Maximum amount of entities in a one page (required)
|
|
2896
|
+
:param int page: Sequence number of page starting from 0 (required)
|
|
2897
|
+
:param str text_search: The case insensitive 'startsWith' filter based on the entity group name.
|
|
2898
|
+
:param str sort_property: Property of entity to sort by
|
|
2899
|
+
:param str sort_order: Sort order. ASC (ASCENDING) or DESC (DESCENDING)
|
|
2900
|
+
:return: PageDataEntityInfo
|
|
2901
|
+
If the method is called asynchronously,
|
|
2902
|
+
returns the request thread.
|
|
2903
|
+
"""
|
|
2904
|
+
kwargs['_return_http_data_only'] = True
|
|
2905
|
+
if kwargs.get('async_req'):
|
|
2906
|
+
return self.get_shared_entity_group_entity_infos_by_type_and_page_link_using_get_with_http_info(group_type, page_size, page, **kwargs) # noqa: E501
|
|
2907
|
+
else:
|
|
2908
|
+
(data) = self.get_shared_entity_group_entity_infos_by_type_and_page_link_using_get_with_http_info(group_type, page_size, page, **kwargs) # noqa: E501
|
|
2909
|
+
return data
|
|
2910
|
+
|
|
2911
|
+
def get_shared_entity_group_entity_infos_by_type_and_page_link_using_get_with_http_info(self, group_type, page_size, page, **kwargs): # noqa: E501
|
|
2912
|
+
"""Get Shared Entity Group Entity Infos by entity type and page link (getSharedEntityGroupEntityInfosByTypeAndPageLink) # noqa: E501
|
|
2913
|
+
|
|
2914
|
+
Returns a page of Shared Entity Group Entity Info objects based on the provided Entity Type and Page Link. Entity Info is a lightweight object that contains only id and name of the entity group. You can specify parameters to filter the results. The result is wrapped with PageData object that allows you to iterate over result set using pagination. See the 'Model' tab of the Response Class for more details. Available for users with 'TENANT_ADMIN' or 'CUSTOMER_USER' authority. Security check is performed to verify that the user has 'READ' permission for specified group. # noqa: E501
|
|
2915
|
+
This method makes a synchronous HTTP request by default. To make an
|
|
2916
|
+
asynchronous HTTP request, please pass async_req=True
|
|
2917
|
+
>>> thread = api.get_shared_entity_group_entity_infos_by_type_and_page_link_using_get_with_http_info(group_type, page_size, page, async_req=True)
|
|
2918
|
+
>>> result = thread.get()
|
|
2919
|
+
|
|
2920
|
+
:param async_req bool
|
|
2921
|
+
:param str group_type: Entity Group type (required)
|
|
2922
|
+
:param int page_size: Maximum amount of entities in a one page (required)
|
|
2923
|
+
:param int page: Sequence number of page starting from 0 (required)
|
|
2924
|
+
:param str text_search: The case insensitive 'startsWith' filter based on the entity group name.
|
|
2925
|
+
:param str sort_property: Property of entity to sort by
|
|
2926
|
+
:param str sort_order: Sort order. ASC (ASCENDING) or DESC (DESCENDING)
|
|
2927
|
+
:return: PageDataEntityInfo
|
|
2928
|
+
If the method is called asynchronously,
|
|
2929
|
+
returns the request thread.
|
|
2930
|
+
"""
|
|
2931
|
+
|
|
2932
|
+
all_params = ['group_type', 'page_size', 'page', 'text_search', 'sort_property', 'sort_order'] # noqa: E501
|
|
2933
|
+
all_params.append('async_req')
|
|
2934
|
+
all_params.append('_return_http_data_only')
|
|
2935
|
+
all_params.append('_preload_content')
|
|
2936
|
+
all_params.append('_request_timeout')
|
|
2937
|
+
|
|
2938
|
+
params = locals()
|
|
2939
|
+
for key, val in six.iteritems(params['kwargs']):
|
|
2940
|
+
if key not in all_params:
|
|
2941
|
+
raise TypeError(
|
|
2942
|
+
"Got an unexpected keyword argument '%s'"
|
|
2943
|
+
" to method get_shared_entity_group_entity_infos_by_type_and_page_link_using_get" % key
|
|
2944
|
+
)
|
|
2945
|
+
params[key] = val
|
|
2946
|
+
del params['kwargs']
|
|
2947
|
+
# verify the required parameter 'group_type' is set
|
|
2948
|
+
if ('group_type' not in params or
|
|
2949
|
+
params['group_type'] is None):
|
|
2950
|
+
raise ValueError("Missing the required parameter `group_type` when calling `get_shared_entity_group_entity_infos_by_type_and_page_link_using_get`") # noqa: E501
|
|
2951
|
+
# verify the required parameter 'page_size' is set
|
|
2952
|
+
if ('page_size' not in params or
|
|
2953
|
+
params['page_size'] is None):
|
|
2954
|
+
raise ValueError("Missing the required parameter `page_size` when calling `get_shared_entity_group_entity_infos_by_type_and_page_link_using_get`") # noqa: E501
|
|
2955
|
+
# verify the required parameter 'page' is set
|
|
2956
|
+
if ('page' not in params or
|
|
2957
|
+
params['page'] is None):
|
|
2958
|
+
raise ValueError("Missing the required parameter `page` when calling `get_shared_entity_group_entity_infos_by_type_and_page_link_using_get`") # noqa: E501
|
|
2959
|
+
|
|
2960
|
+
collection_formats = {}
|
|
2961
|
+
|
|
2962
|
+
path_params = {}
|
|
2963
|
+
if 'group_type' in params:
|
|
2964
|
+
path_params['groupType'] = params['group_type'] # noqa: E501
|
|
2965
|
+
|
|
2966
|
+
query_params = []
|
|
2967
|
+
if 'page_size' in params:
|
|
2968
|
+
query_params.append(('pageSize', params['page_size'])) # noqa: E501
|
|
2969
|
+
if 'page' in params:
|
|
2970
|
+
query_params.append(('page', params['page'])) # noqa: E501
|
|
2971
|
+
if 'text_search' in params:
|
|
2972
|
+
query_params.append(('textSearch', params['text_search'])) # noqa: E501
|
|
2973
|
+
if 'sort_property' in params:
|
|
2974
|
+
query_params.append(('sortProperty', params['sort_property'])) # noqa: E501
|
|
2975
|
+
if 'sort_order' in params:
|
|
2976
|
+
query_params.append(('sortOrder', params['sort_order'])) # noqa: E501
|
|
2977
|
+
|
|
2978
|
+
header_params = {}
|
|
2979
|
+
|
|
2980
|
+
form_params = []
|
|
2981
|
+
local_var_files = {}
|
|
2982
|
+
|
|
2983
|
+
body_params = None
|
|
2984
|
+
# HTTP header `Accept`
|
|
2985
|
+
header_params['Accept'] = self.api_client.select_header_accept(
|
|
2986
|
+
['application/json']) # noqa: E501
|
|
2987
|
+
|
|
2988
|
+
# Authentication setting
|
|
2989
|
+
auth_settings = ['X-Authorization'] # noqa: E501
|
|
2990
|
+
|
|
2991
|
+
return self.api_client.call_api(
|
|
2992
|
+
'/api/entityGroupInfos/{groupType}/shared{?page,pageSize,sortOrder,sortProperty,textSearch}', 'GET',
|
|
2993
|
+
path_params,
|
|
2994
|
+
query_params,
|
|
2995
|
+
header_params,
|
|
2996
|
+
body=body_params,
|
|
2997
|
+
post_params=form_params,
|
|
2998
|
+
files=local_var_files,
|
|
2999
|
+
response_type='PageDataEntityInfo', # noqa: E501
|
|
3000
|
+
auth_settings=auth_settings,
|
|
3001
|
+
async_req=params.get('async_req'),
|
|
3002
|
+
_return_http_data_only=params.get('_return_http_data_only'),
|
|
3003
|
+
_preload_content=params.get('_preload_content', True),
|
|
3004
|
+
_request_timeout=params.get('_request_timeout'),
|
|
3005
|
+
collection_formats=collection_formats)
|
|
3006
|
+
|
|
3007
|
+
def get_shared_entity_groups_by_type_and_page_link_using_get(self, group_type, page_size, page, **kwargs): # noqa: E501
|
|
3008
|
+
"""Get Shared Entity Groups by entity type and page link (getSharedEntityGroupsByTypeAndPageLink) # noqa: E501
|
|
3009
|
+
|
|
3010
|
+
Returns a page of Shared Entity Group Info objects based on the provided Entity Type and Page Link. Entity group allows you to group multiple entities of the same entity type (Device, Asset, Customer, User, Dashboard, etc). Entity Group always have an owner - particular Tenant or Customer. Each entity may belong to multiple groups simultaneously.Entity Group Info extends Entity Group object and adds 'ownerIds' - a list of owner ids.You can specify parameters to filter the results. The result is wrapped with PageData object that allows you to iterate over result set using pagination. See the 'Model' tab of the Response Class for more details. Available for users with 'TENANT_ADMIN' or 'CUSTOMER_USER' authority. Security check is performed to verify that the user has 'READ' permission for specified group. # noqa: E501
|
|
3011
|
+
This method makes a synchronous HTTP request by default. To make an
|
|
3012
|
+
asynchronous HTTP request, please pass async_req=True
|
|
3013
|
+
>>> thread = api.get_shared_entity_groups_by_type_and_page_link_using_get(group_type, page_size, page, async_req=True)
|
|
3014
|
+
>>> result = thread.get()
|
|
3015
|
+
|
|
3016
|
+
:param async_req bool
|
|
3017
|
+
:param str group_type: Entity Group type (required)
|
|
3018
|
+
:param int page_size: Maximum amount of entities in a one page (required)
|
|
3019
|
+
:param int page: Sequence number of page starting from 0 (required)
|
|
3020
|
+
:param str text_search: The case insensitive 'startsWith' filter based on the entity group name.
|
|
3021
|
+
:param str sort_property: Property of entity to sort by
|
|
3022
|
+
:param str sort_order: Sort order. ASC (ASCENDING) or DESC (DESCENDING)
|
|
3023
|
+
:return: PageDataEntityGroupInfo
|
|
3024
|
+
If the method is called asynchronously,
|
|
3025
|
+
returns the request thread.
|
|
3026
|
+
"""
|
|
3027
|
+
kwargs['_return_http_data_only'] = True
|
|
3028
|
+
if kwargs.get('async_req'):
|
|
3029
|
+
return self.get_shared_entity_groups_by_type_and_page_link_using_get_with_http_info(group_type, page_size, page, **kwargs) # noqa: E501
|
|
3030
|
+
else:
|
|
3031
|
+
(data) = self.get_shared_entity_groups_by_type_and_page_link_using_get_with_http_info(group_type, page_size, page, **kwargs) # noqa: E501
|
|
3032
|
+
return data
|
|
3033
|
+
|
|
3034
|
+
def get_shared_entity_groups_by_type_and_page_link_using_get_with_http_info(self, group_type, page_size, page, **kwargs): # noqa: E501
|
|
3035
|
+
"""Get Shared Entity Groups by entity type and page link (getSharedEntityGroupsByTypeAndPageLink) # noqa: E501
|
|
3036
|
+
|
|
3037
|
+
Returns a page of Shared Entity Group Info objects based on the provided Entity Type and Page Link. Entity group allows you to group multiple entities of the same entity type (Device, Asset, Customer, User, Dashboard, etc). Entity Group always have an owner - particular Tenant or Customer. Each entity may belong to multiple groups simultaneously.Entity Group Info extends Entity Group object and adds 'ownerIds' - a list of owner ids.You can specify parameters to filter the results. The result is wrapped with PageData object that allows you to iterate over result set using pagination. See the 'Model' tab of the Response Class for more details. Available for users with 'TENANT_ADMIN' or 'CUSTOMER_USER' authority. Security check is performed to verify that the user has 'READ' permission for specified group. # noqa: E501
|
|
3038
|
+
This method makes a synchronous HTTP request by default. To make an
|
|
3039
|
+
asynchronous HTTP request, please pass async_req=True
|
|
3040
|
+
>>> thread = api.get_shared_entity_groups_by_type_and_page_link_using_get_with_http_info(group_type, page_size, page, async_req=True)
|
|
3041
|
+
>>> result = thread.get()
|
|
3042
|
+
|
|
3043
|
+
:param async_req bool
|
|
3044
|
+
:param str group_type: Entity Group type (required)
|
|
3045
|
+
:param int page_size: Maximum amount of entities in a one page (required)
|
|
3046
|
+
:param int page: Sequence number of page starting from 0 (required)
|
|
3047
|
+
:param str text_search: The case insensitive 'startsWith' filter based on the entity group name.
|
|
3048
|
+
:param str sort_property: Property of entity to sort by
|
|
3049
|
+
:param str sort_order: Sort order. ASC (ASCENDING) or DESC (DESCENDING)
|
|
3050
|
+
:return: PageDataEntityGroupInfo
|
|
3051
|
+
If the method is called asynchronously,
|
|
3052
|
+
returns the request thread.
|
|
3053
|
+
"""
|
|
3054
|
+
|
|
3055
|
+
all_params = ['group_type', 'page_size', 'page', 'text_search', 'sort_property', 'sort_order'] # noqa: E501
|
|
3056
|
+
all_params.append('async_req')
|
|
3057
|
+
all_params.append('_return_http_data_only')
|
|
3058
|
+
all_params.append('_preload_content')
|
|
3059
|
+
all_params.append('_request_timeout')
|
|
3060
|
+
|
|
3061
|
+
params = locals()
|
|
3062
|
+
for key, val in six.iteritems(params['kwargs']):
|
|
3063
|
+
if key not in all_params:
|
|
3064
|
+
raise TypeError(
|
|
3065
|
+
"Got an unexpected keyword argument '%s'"
|
|
3066
|
+
" to method get_shared_entity_groups_by_type_and_page_link_using_get" % key
|
|
3067
|
+
)
|
|
3068
|
+
params[key] = val
|
|
3069
|
+
del params['kwargs']
|
|
3070
|
+
# verify the required parameter 'group_type' is set
|
|
3071
|
+
if ('group_type' not in params or
|
|
3072
|
+
params['group_type'] is None):
|
|
3073
|
+
raise ValueError("Missing the required parameter `group_type` when calling `get_shared_entity_groups_by_type_and_page_link_using_get`") # noqa: E501
|
|
3074
|
+
# verify the required parameter 'page_size' is set
|
|
3075
|
+
if ('page_size' not in params or
|
|
3076
|
+
params['page_size'] is None):
|
|
3077
|
+
raise ValueError("Missing the required parameter `page_size` when calling `get_shared_entity_groups_by_type_and_page_link_using_get`") # noqa: E501
|
|
3078
|
+
# verify the required parameter 'page' is set
|
|
3079
|
+
if ('page' not in params or
|
|
3080
|
+
params['page'] is None):
|
|
3081
|
+
raise ValueError("Missing the required parameter `page` when calling `get_shared_entity_groups_by_type_and_page_link_using_get`") # noqa: E501
|
|
3082
|
+
|
|
3083
|
+
collection_formats = {}
|
|
3084
|
+
|
|
3085
|
+
path_params = {}
|
|
3086
|
+
if 'group_type' in params:
|
|
3087
|
+
path_params['groupType'] = params['group_type'] # noqa: E501
|
|
3088
|
+
|
|
3089
|
+
query_params = []
|
|
3090
|
+
if 'page_size' in params:
|
|
3091
|
+
query_params.append(('pageSize', params['page_size'])) # noqa: E501
|
|
3092
|
+
if 'page' in params:
|
|
3093
|
+
query_params.append(('page', params['page'])) # noqa: E501
|
|
3094
|
+
if 'text_search' in params:
|
|
3095
|
+
query_params.append(('textSearch', params['text_search'])) # noqa: E501
|
|
3096
|
+
if 'sort_property' in params:
|
|
3097
|
+
query_params.append(('sortProperty', params['sort_property'])) # noqa: E501
|
|
3098
|
+
if 'sort_order' in params:
|
|
3099
|
+
query_params.append(('sortOrder', params['sort_order'])) # noqa: E501
|
|
3100
|
+
|
|
3101
|
+
header_params = {}
|
|
3102
|
+
|
|
3103
|
+
form_params = []
|
|
3104
|
+
local_var_files = {}
|
|
3105
|
+
|
|
3106
|
+
body_params = None
|
|
3107
|
+
# HTTP header `Accept`
|
|
3108
|
+
header_params['Accept'] = self.api_client.select_header_accept(
|
|
3109
|
+
['application/json']) # noqa: E501
|
|
3110
|
+
|
|
3111
|
+
# Authentication setting
|
|
3112
|
+
auth_settings = ['X-Authorization'] # noqa: E501
|
|
3113
|
+
|
|
3114
|
+
return self.api_client.call_api(
|
|
3115
|
+
'/api/entityGroups/{groupType}/shared{?page,pageSize,sortOrder,sortProperty,textSearch}', 'GET',
|
|
3116
|
+
path_params,
|
|
3117
|
+
query_params,
|
|
3118
|
+
header_params,
|
|
3119
|
+
body=body_params,
|
|
3120
|
+
post_params=form_params,
|
|
3121
|
+
files=local_var_files,
|
|
3122
|
+
response_type='PageDataEntityGroupInfo', # noqa: E501
|
|
3123
|
+
auth_settings=auth_settings,
|
|
3124
|
+
async_req=params.get('async_req'),
|
|
3125
|
+
_return_http_data_only=params.get('_return_http_data_only'),
|
|
3126
|
+
_preload_content=params.get('_preload_content', True),
|
|
3127
|
+
_request_timeout=params.get('_request_timeout'),
|
|
3128
|
+
collection_formats=collection_formats)
|
|
3129
|
+
|
|
3130
|
+
def get_shared_entity_groups_by_type_using_get(self, group_type, **kwargs): # noqa: E501
|
|
3131
|
+
"""Get Shared Entity Groups by entity type (getSharedEntityGroupsByType) # noqa: E501
|
|
3132
|
+
|
|
3133
|
+
Fetch the list of Shared Entity Group Info objects based on the provided Entity Type. Entity group allows you to group multiple entities of the same entity type (Device, Asset, Customer, User, Dashboard, etc). Entity Group always have an owner - particular Tenant or Customer. Each entity may belong to multiple groups simultaneously.Entity Group Info extends Entity Group object and adds 'ownerIds' - a list of owner ids. Available for users with 'TENANT_ADMIN' or 'CUSTOMER_USER' authority. Security check is performed to verify that the user has 'READ' permission for specified group. # noqa: E501
|
|
3134
|
+
This method makes a synchronous HTTP request by default. To make an
|
|
3135
|
+
asynchronous HTTP request, please pass async_req=True
|
|
3136
|
+
>>> thread = api.get_shared_entity_groups_by_type_using_get(group_type, async_req=True)
|
|
3137
|
+
>>> result = thread.get()
|
|
3138
|
+
|
|
3139
|
+
:param async_req bool
|
|
3140
|
+
:param str group_type: Entity Group type (required)
|
|
3141
|
+
:return: list[EntityGroupInfo]
|
|
3142
|
+
If the method is called asynchronously,
|
|
3143
|
+
returns the request thread.
|
|
3144
|
+
"""
|
|
3145
|
+
kwargs['_return_http_data_only'] = True
|
|
3146
|
+
if kwargs.get('async_req'):
|
|
3147
|
+
return self.get_shared_entity_groups_by_type_using_get_with_http_info(group_type, **kwargs) # noqa: E501
|
|
3148
|
+
else:
|
|
3149
|
+
(data) = self.get_shared_entity_groups_by_type_using_get_with_http_info(group_type, **kwargs) # noqa: E501
|
|
3150
|
+
return data
|
|
3151
|
+
|
|
3152
|
+
def get_shared_entity_groups_by_type_using_get_with_http_info(self, group_type, **kwargs): # noqa: E501
|
|
3153
|
+
"""Get Shared Entity Groups by entity type (getSharedEntityGroupsByType) # noqa: E501
|
|
3154
|
+
|
|
3155
|
+
Fetch the list of Shared Entity Group Info objects based on the provided Entity Type. Entity group allows you to group multiple entities of the same entity type (Device, Asset, Customer, User, Dashboard, etc). Entity Group always have an owner - particular Tenant or Customer. Each entity may belong to multiple groups simultaneously.Entity Group Info extends Entity Group object and adds 'ownerIds' - a list of owner ids. Available for users with 'TENANT_ADMIN' or 'CUSTOMER_USER' authority. Security check is performed to verify that the user has 'READ' permission for specified group. # noqa: E501
|
|
3156
|
+
This method makes a synchronous HTTP request by default. To make an
|
|
3157
|
+
asynchronous HTTP request, please pass async_req=True
|
|
3158
|
+
>>> thread = api.get_shared_entity_groups_by_type_using_get_with_http_info(group_type, async_req=True)
|
|
3159
|
+
>>> result = thread.get()
|
|
3160
|
+
|
|
3161
|
+
:param async_req bool
|
|
3162
|
+
:param str group_type: Entity Group type (required)
|
|
3163
|
+
:return: list[EntityGroupInfo]
|
|
3164
|
+
If the method is called asynchronously,
|
|
3165
|
+
returns the request thread.
|
|
3166
|
+
"""
|
|
3167
|
+
|
|
3168
|
+
all_params = ['group_type'] # noqa: E501
|
|
3169
|
+
all_params.append('async_req')
|
|
3170
|
+
all_params.append('_return_http_data_only')
|
|
3171
|
+
all_params.append('_preload_content')
|
|
3172
|
+
all_params.append('_request_timeout')
|
|
3173
|
+
|
|
3174
|
+
params = locals()
|
|
3175
|
+
for key, val in six.iteritems(params['kwargs']):
|
|
3176
|
+
if key not in all_params:
|
|
3177
|
+
raise TypeError(
|
|
3178
|
+
"Got an unexpected keyword argument '%s'"
|
|
3179
|
+
" to method get_shared_entity_groups_by_type_using_get" % key
|
|
3180
|
+
)
|
|
3181
|
+
params[key] = val
|
|
3182
|
+
del params['kwargs']
|
|
3183
|
+
# verify the required parameter 'group_type' is set
|
|
3184
|
+
if ('group_type' not in params or
|
|
3185
|
+
params['group_type'] is None):
|
|
3186
|
+
raise ValueError("Missing the required parameter `group_type` when calling `get_shared_entity_groups_by_type_using_get`") # noqa: E501
|
|
3187
|
+
|
|
3188
|
+
collection_formats = {}
|
|
3189
|
+
|
|
3190
|
+
path_params = {}
|
|
3191
|
+
if 'group_type' in params:
|
|
3192
|
+
path_params['groupType'] = params['group_type'] # noqa: E501
|
|
3193
|
+
|
|
3194
|
+
query_params = []
|
|
3195
|
+
|
|
3196
|
+
header_params = {}
|
|
3197
|
+
|
|
3198
|
+
form_params = []
|
|
3199
|
+
local_var_files = {}
|
|
3200
|
+
|
|
3201
|
+
body_params = None
|
|
3202
|
+
# HTTP header `Accept`
|
|
3203
|
+
header_params['Accept'] = self.api_client.select_header_accept(
|
|
3204
|
+
['application/json']) # noqa: E501
|
|
3205
|
+
|
|
3206
|
+
# Authentication setting
|
|
3207
|
+
auth_settings = ['X-Authorization'] # noqa: E501
|
|
3208
|
+
|
|
3209
|
+
return self.api_client.call_api(
|
|
3210
|
+
'/api/entityGroups/{groupType}/shared', 'GET',
|
|
3211
|
+
path_params,
|
|
3212
|
+
query_params,
|
|
3213
|
+
header_params,
|
|
3214
|
+
body=body_params,
|
|
3215
|
+
post_params=form_params,
|
|
3216
|
+
files=local_var_files,
|
|
3217
|
+
response_type='list[EntityGroupInfo]', # noqa: E501
|
|
3218
|
+
auth_settings=auth_settings,
|
|
3219
|
+
async_req=params.get('async_req'),
|
|
3220
|
+
_return_http_data_only=params.get('_return_http_data_only'),
|
|
3221
|
+
_preload_content=params.get('_preload_content', True),
|
|
3222
|
+
_request_timeout=params.get('_request_timeout'),
|
|
3223
|
+
collection_formats=collection_formats)
|
|
3224
|
+
|
|
3225
|
+
def make_entity_group_private_using_post(self, entity_group_id, **kwargs): # noqa: E501
|
|
3226
|
+
"""Make Entity Group Private (makeEntityGroupPrivate) # noqa: E501
|
|
3227
|
+
|
|
3228
|
+
Make the entity group not available for non authorized users. Every group is private by default. This call is useful to hide the group that was previously made public. Available for users with 'TENANT_ADMIN' or 'CUSTOMER_USER' authority. Security check is performed to verify that the user has 'WRITE' permission for specified group. # noqa: E501
|
|
3229
|
+
This method makes a synchronous HTTP request by default. To make an
|
|
3230
|
+
asynchronous HTTP request, please pass async_req=True
|
|
3231
|
+
>>> thread = api.make_entity_group_private_using_post(entity_group_id, async_req=True)
|
|
3232
|
+
>>> result = thread.get()
|
|
3233
|
+
|
|
3234
|
+
:param async_req bool
|
|
3235
|
+
:param str entity_group_id: A string value representing the Entity Group Id. For example, '784f394c-42b6-435a-983c-b7beff2784f9' (required)
|
|
3236
|
+
:return: None
|
|
3237
|
+
If the method is called asynchronously,
|
|
3238
|
+
returns the request thread.
|
|
3239
|
+
"""
|
|
3240
|
+
kwargs['_return_http_data_only'] = True
|
|
3241
|
+
if kwargs.get('async_req'):
|
|
3242
|
+
return self.make_entity_group_private_using_post_with_http_info(entity_group_id, **kwargs) # noqa: E501
|
|
3243
|
+
else:
|
|
3244
|
+
(data) = self.make_entity_group_private_using_post_with_http_info(entity_group_id, **kwargs) # noqa: E501
|
|
3245
|
+
return data
|
|
3246
|
+
|
|
3247
|
+
def make_entity_group_private_using_post_with_http_info(self, entity_group_id, **kwargs): # noqa: E501
|
|
3248
|
+
"""Make Entity Group Private (makeEntityGroupPrivate) # noqa: E501
|
|
3249
|
+
|
|
3250
|
+
Make the entity group not available for non authorized users. Every group is private by default. This call is useful to hide the group that was previously made public. Available for users with 'TENANT_ADMIN' or 'CUSTOMER_USER' authority. Security check is performed to verify that the user has 'WRITE' permission for specified group. # noqa: E501
|
|
3251
|
+
This method makes a synchronous HTTP request by default. To make an
|
|
3252
|
+
asynchronous HTTP request, please pass async_req=True
|
|
3253
|
+
>>> thread = api.make_entity_group_private_using_post_with_http_info(entity_group_id, async_req=True)
|
|
3254
|
+
>>> result = thread.get()
|
|
3255
|
+
|
|
3256
|
+
:param async_req bool
|
|
3257
|
+
:param str entity_group_id: A string value representing the Entity Group Id. For example, '784f394c-42b6-435a-983c-b7beff2784f9' (required)
|
|
3258
|
+
:return: None
|
|
3259
|
+
If the method is called asynchronously,
|
|
3260
|
+
returns the request thread.
|
|
3261
|
+
"""
|
|
3262
|
+
|
|
3263
|
+
all_params = ['entity_group_id'] # noqa: E501
|
|
3264
|
+
all_params.append('async_req')
|
|
3265
|
+
all_params.append('_return_http_data_only')
|
|
3266
|
+
all_params.append('_preload_content')
|
|
3267
|
+
all_params.append('_request_timeout')
|
|
3268
|
+
|
|
3269
|
+
params = locals()
|
|
3270
|
+
for key, val in six.iteritems(params['kwargs']):
|
|
3271
|
+
if key not in all_params:
|
|
3272
|
+
raise TypeError(
|
|
3273
|
+
"Got an unexpected keyword argument '%s'"
|
|
3274
|
+
" to method make_entity_group_private_using_post" % key
|
|
3275
|
+
)
|
|
3276
|
+
params[key] = val
|
|
3277
|
+
del params['kwargs']
|
|
3278
|
+
# verify the required parameter 'entity_group_id' is set
|
|
3279
|
+
if ('entity_group_id' not in params or
|
|
3280
|
+
params['entity_group_id'] is None):
|
|
3281
|
+
raise ValueError("Missing the required parameter `entity_group_id` when calling `make_entity_group_private_using_post`") # noqa: E501
|
|
3282
|
+
|
|
3283
|
+
collection_formats = {}
|
|
3284
|
+
|
|
3285
|
+
path_params = {}
|
|
3286
|
+
if 'entity_group_id' in params:
|
|
3287
|
+
path_params['entityGroupId'] = params['entity_group_id'] # noqa: E501
|
|
3288
|
+
|
|
3289
|
+
query_params = []
|
|
3290
|
+
|
|
3291
|
+
header_params = {}
|
|
3292
|
+
|
|
3293
|
+
form_params = []
|
|
3294
|
+
local_var_files = {}
|
|
3295
|
+
|
|
3296
|
+
body_params = None
|
|
3297
|
+
# HTTP header `Accept`
|
|
3298
|
+
header_params['Accept'] = self.api_client.select_header_accept(
|
|
3299
|
+
['application/json']) # noqa: E501
|
|
3300
|
+
|
|
3301
|
+
# Authentication setting
|
|
3302
|
+
auth_settings = ['X-Authorization'] # noqa: E501
|
|
3303
|
+
|
|
3304
|
+
return self.api_client.call_api(
|
|
3305
|
+
'/api/entityGroup/{entityGroupId}/makePrivate', 'POST',
|
|
3306
|
+
path_params,
|
|
3307
|
+
query_params,
|
|
3308
|
+
header_params,
|
|
3309
|
+
body=body_params,
|
|
3310
|
+
post_params=form_params,
|
|
3311
|
+
files=local_var_files,
|
|
3312
|
+
response_type=None, # noqa: E501
|
|
3313
|
+
auth_settings=auth_settings,
|
|
3314
|
+
async_req=params.get('async_req'),
|
|
3315
|
+
_return_http_data_only=params.get('_return_http_data_only'),
|
|
3316
|
+
_preload_content=params.get('_preload_content', True),
|
|
3317
|
+
_request_timeout=params.get('_request_timeout'),
|
|
3318
|
+
collection_formats=collection_formats)
|
|
3319
|
+
|
|
3320
|
+
def make_entity_group_public_using_post(self, entity_group_id, **kwargs): # noqa: E501
|
|
3321
|
+
"""Make Entity Group Publicly available (makeEntityGroupPublic) # noqa: E501
|
|
3322
|
+
|
|
3323
|
+
Make the entity group available for non authorized users. Useful for public dashboards that will be embedded into the public websites. Available for users with 'TENANT_ADMIN' or 'CUSTOMER_USER' authority. Security check is performed to verify that the user has 'WRITE' permission for specified group. # noqa: E501
|
|
3324
|
+
This method makes a synchronous HTTP request by default. To make an
|
|
3325
|
+
asynchronous HTTP request, please pass async_req=True
|
|
3326
|
+
>>> thread = api.make_entity_group_public_using_post(entity_group_id, async_req=True)
|
|
3327
|
+
>>> result = thread.get()
|
|
3328
|
+
|
|
3329
|
+
:param async_req bool
|
|
3330
|
+
:param str entity_group_id: A string value representing the Entity Group Id. For example, '784f394c-42b6-435a-983c-b7beff2784f9' (required)
|
|
3331
|
+
:return: None
|
|
3332
|
+
If the method is called asynchronously,
|
|
3333
|
+
returns the request thread.
|
|
3334
|
+
"""
|
|
3335
|
+
kwargs['_return_http_data_only'] = True
|
|
3336
|
+
if kwargs.get('async_req'):
|
|
3337
|
+
return self.make_entity_group_public_using_post_with_http_info(entity_group_id, **kwargs) # noqa: E501
|
|
3338
|
+
else:
|
|
3339
|
+
(data) = self.make_entity_group_public_using_post_with_http_info(entity_group_id, **kwargs) # noqa: E501
|
|
3340
|
+
return data
|
|
3341
|
+
|
|
3342
|
+
def make_entity_group_public_using_post_with_http_info(self, entity_group_id, **kwargs): # noqa: E501
|
|
3343
|
+
"""Make Entity Group Publicly available (makeEntityGroupPublic) # noqa: E501
|
|
3344
|
+
|
|
3345
|
+
Make the entity group available for non authorized users. Useful for public dashboards that will be embedded into the public websites. Available for users with 'TENANT_ADMIN' or 'CUSTOMER_USER' authority. Security check is performed to verify that the user has 'WRITE' permission for specified group. # noqa: E501
|
|
3346
|
+
This method makes a synchronous HTTP request by default. To make an
|
|
3347
|
+
asynchronous HTTP request, please pass async_req=True
|
|
3348
|
+
>>> thread = api.make_entity_group_public_using_post_with_http_info(entity_group_id, async_req=True)
|
|
3349
|
+
>>> result = thread.get()
|
|
3350
|
+
|
|
3351
|
+
:param async_req bool
|
|
3352
|
+
:param str entity_group_id: A string value representing the Entity Group Id. For example, '784f394c-42b6-435a-983c-b7beff2784f9' (required)
|
|
3353
|
+
:return: None
|
|
3354
|
+
If the method is called asynchronously,
|
|
3355
|
+
returns the request thread.
|
|
3356
|
+
"""
|
|
3357
|
+
|
|
3358
|
+
all_params = ['entity_group_id'] # noqa: E501
|
|
3359
|
+
all_params.append('async_req')
|
|
3360
|
+
all_params.append('_return_http_data_only')
|
|
3361
|
+
all_params.append('_preload_content')
|
|
3362
|
+
all_params.append('_request_timeout')
|
|
3363
|
+
|
|
3364
|
+
params = locals()
|
|
3365
|
+
for key, val in six.iteritems(params['kwargs']):
|
|
3366
|
+
if key not in all_params:
|
|
3367
|
+
raise TypeError(
|
|
3368
|
+
"Got an unexpected keyword argument '%s'"
|
|
3369
|
+
" to method make_entity_group_public_using_post" % key
|
|
3370
|
+
)
|
|
3371
|
+
params[key] = val
|
|
3372
|
+
del params['kwargs']
|
|
3373
|
+
# verify the required parameter 'entity_group_id' is set
|
|
3374
|
+
if ('entity_group_id' not in params or
|
|
3375
|
+
params['entity_group_id'] is None):
|
|
3376
|
+
raise ValueError("Missing the required parameter `entity_group_id` when calling `make_entity_group_public_using_post`") # noqa: E501
|
|
3377
|
+
|
|
3378
|
+
collection_formats = {}
|
|
3379
|
+
|
|
3380
|
+
path_params = {}
|
|
3381
|
+
if 'entity_group_id' in params:
|
|
3382
|
+
path_params['entityGroupId'] = params['entity_group_id'] # noqa: E501
|
|
3383
|
+
|
|
3384
|
+
query_params = []
|
|
3385
|
+
|
|
3386
|
+
header_params = {}
|
|
3387
|
+
|
|
3388
|
+
form_params = []
|
|
3389
|
+
local_var_files = {}
|
|
3390
|
+
|
|
3391
|
+
body_params = None
|
|
3392
|
+
# HTTP header `Accept`
|
|
3393
|
+
header_params['Accept'] = self.api_client.select_header_accept(
|
|
3394
|
+
['application/json']) # noqa: E501
|
|
3395
|
+
|
|
3396
|
+
# Authentication setting
|
|
3397
|
+
auth_settings = ['X-Authorization'] # noqa: E501
|
|
3398
|
+
|
|
3399
|
+
return self.api_client.call_api(
|
|
3400
|
+
'/api/entityGroup/{entityGroupId}/makePublic', 'POST',
|
|
3401
|
+
path_params,
|
|
3402
|
+
query_params,
|
|
3403
|
+
header_params,
|
|
3404
|
+
body=body_params,
|
|
3405
|
+
post_params=form_params,
|
|
3406
|
+
files=local_var_files,
|
|
3407
|
+
response_type=None, # noqa: E501
|
|
3408
|
+
auth_settings=auth_settings,
|
|
3409
|
+
async_req=params.get('async_req'),
|
|
3410
|
+
_return_http_data_only=params.get('_return_http_data_only'),
|
|
3411
|
+
_preload_content=params.get('_preload_content', True),
|
|
3412
|
+
_request_timeout=params.get('_request_timeout'),
|
|
3413
|
+
collection_formats=collection_formats)
|
|
3414
|
+
|
|
3415
|
+
def remove_entities_from_entity_group_using_post(self, entity_group_id, **kwargs): # noqa: E501
|
|
3416
|
+
"""Remove entities from the group (removeEntitiesFromEntityGroup) # noqa: E501
|
|
3417
|
+
|
|
3418
|
+
Removes entities from the specified entity group. Entity group allows you to group multiple entities of the same entity type (Device, Asset, Customer, User, Dashboard, etc). Entity Group always have an owner - particular Tenant or Customer. Each entity may belong to multiple groups simultaneously. Available for users with 'TENANT_ADMIN' or 'CUSTOMER_USER' authority. Security check is performed to verify that the user has 'REMOVE_FROM_GROUP' permission for specified group. # noqa: E501
|
|
3419
|
+
This method makes a synchronous HTTP request by default. To make an
|
|
3420
|
+
asynchronous HTTP request, please pass async_req=True
|
|
3421
|
+
>>> thread = api.remove_entities_from_entity_group_using_post(entity_group_id, async_req=True)
|
|
3422
|
+
>>> result = thread.get()
|
|
3423
|
+
|
|
3424
|
+
:param async_req bool
|
|
3425
|
+
:param str entity_group_id: A string value representing the Entity Group Id. For example, '784f394c-42b6-435a-983c-b7beff2784f9' (required)
|
|
3426
|
+
:param list[str] body:
|
|
3427
|
+
:return: None
|
|
3428
|
+
If the method is called asynchronously,
|
|
3429
|
+
returns the request thread.
|
|
3430
|
+
"""
|
|
3431
|
+
kwargs['_return_http_data_only'] = True
|
|
3432
|
+
if kwargs.get('async_req'):
|
|
3433
|
+
return self.remove_entities_from_entity_group_using_post_with_http_info(entity_group_id, **kwargs) # noqa: E501
|
|
3434
|
+
else:
|
|
3435
|
+
(data) = self.remove_entities_from_entity_group_using_post_with_http_info(entity_group_id, **kwargs) # noqa: E501
|
|
3436
|
+
return data
|
|
3437
|
+
|
|
3438
|
+
def remove_entities_from_entity_group_using_post_with_http_info(self, entity_group_id, **kwargs): # noqa: E501
|
|
3439
|
+
"""Remove entities from the group (removeEntitiesFromEntityGroup) # noqa: E501
|
|
3440
|
+
|
|
3441
|
+
Removes entities from the specified entity group. Entity group allows you to group multiple entities of the same entity type (Device, Asset, Customer, User, Dashboard, etc). Entity Group always have an owner - particular Tenant or Customer. Each entity may belong to multiple groups simultaneously. Available for users with 'TENANT_ADMIN' or 'CUSTOMER_USER' authority. Security check is performed to verify that the user has 'REMOVE_FROM_GROUP' permission for specified group. # noqa: E501
|
|
3442
|
+
This method makes a synchronous HTTP request by default. To make an
|
|
3443
|
+
asynchronous HTTP request, please pass async_req=True
|
|
3444
|
+
>>> thread = api.remove_entities_from_entity_group_using_post_with_http_info(entity_group_id, async_req=True)
|
|
3445
|
+
>>> result = thread.get()
|
|
3446
|
+
|
|
3447
|
+
:param async_req bool
|
|
3448
|
+
:param str entity_group_id: A string value representing the Entity Group Id. For example, '784f394c-42b6-435a-983c-b7beff2784f9' (required)
|
|
3449
|
+
:param list[str] body:
|
|
3450
|
+
:return: None
|
|
3451
|
+
If the method is called asynchronously,
|
|
3452
|
+
returns the request thread.
|
|
3453
|
+
"""
|
|
3454
|
+
|
|
3455
|
+
all_params = ['entity_group_id', 'body'] # noqa: E501
|
|
3456
|
+
all_params.append('async_req')
|
|
3457
|
+
all_params.append('_return_http_data_only')
|
|
3458
|
+
all_params.append('_preload_content')
|
|
3459
|
+
all_params.append('_request_timeout')
|
|
3460
|
+
|
|
3461
|
+
params = locals()
|
|
3462
|
+
for key, val in six.iteritems(params['kwargs']):
|
|
3463
|
+
if key not in all_params:
|
|
3464
|
+
raise TypeError(
|
|
3465
|
+
"Got an unexpected keyword argument '%s'"
|
|
3466
|
+
" to method remove_entities_from_entity_group_using_post" % key
|
|
3467
|
+
)
|
|
3468
|
+
params[key] = val
|
|
3469
|
+
del params['kwargs']
|
|
3470
|
+
# verify the required parameter 'entity_group_id' is set
|
|
3471
|
+
if ('entity_group_id' not in params or
|
|
3472
|
+
params['entity_group_id'] is None):
|
|
3473
|
+
raise ValueError("Missing the required parameter `entity_group_id` when calling `remove_entities_from_entity_group_using_post`") # noqa: E501
|
|
3474
|
+
|
|
3475
|
+
collection_formats = {}
|
|
3476
|
+
|
|
3477
|
+
path_params = {}
|
|
3478
|
+
if 'entity_group_id' in params:
|
|
3479
|
+
path_params['entityGroupId'] = params['entity_group_id'] # noqa: E501
|
|
3480
|
+
|
|
3481
|
+
query_params = []
|
|
3482
|
+
|
|
3483
|
+
header_params = {}
|
|
3484
|
+
|
|
3485
|
+
form_params = []
|
|
3486
|
+
local_var_files = {}
|
|
3487
|
+
|
|
3488
|
+
body_params = None
|
|
3489
|
+
if 'body' in params:
|
|
3490
|
+
body_params = params['body']
|
|
3491
|
+
# HTTP header `Accept`
|
|
3492
|
+
header_params['Accept'] = self.api_client.select_header_accept(
|
|
3493
|
+
['application/json']) # noqa: E501
|
|
3494
|
+
|
|
3495
|
+
# HTTP header `Content-Type`
|
|
3496
|
+
header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501
|
|
3497
|
+
['application/json']) # noqa: E501
|
|
3498
|
+
|
|
3499
|
+
# Authentication setting
|
|
3500
|
+
auth_settings = ['X-Authorization'] # noqa: E501
|
|
3501
|
+
|
|
3502
|
+
return self.api_client.call_api(
|
|
3503
|
+
'/api/entityGroup/{entityGroupId}/deleteEntities', 'POST',
|
|
3504
|
+
path_params,
|
|
3505
|
+
query_params,
|
|
3506
|
+
header_params,
|
|
3507
|
+
body=body_params,
|
|
3508
|
+
post_params=form_params,
|
|
3509
|
+
files=local_var_files,
|
|
3510
|
+
response_type=None, # noqa: E501
|
|
3511
|
+
auth_settings=auth_settings,
|
|
3512
|
+
async_req=params.get('async_req'),
|
|
3513
|
+
_return_http_data_only=params.get('_return_http_data_only'),
|
|
3514
|
+
_preload_content=params.get('_preload_content', True),
|
|
3515
|
+
_request_timeout=params.get('_request_timeout'),
|
|
3516
|
+
collection_formats=collection_formats)
|
|
3517
|
+
|
|
3518
|
+
def save_entity_group_using_post(self, **kwargs): # noqa: E501
|
|
3519
|
+
"""Create Or Update Entity Group (saveEntityGroup) # noqa: E501
|
|
3520
|
+
|
|
3521
|
+
Create or update the Entity Group. When creating Entity Group, platform generates Entity Group Id as [time-based UUID](https://en.wikipedia.org/wiki/Universally_unique_identifier#Version_1_(date-time_and_MAC_address)). The newly created Entity Group Id will be present in the response. Specify existing Entity Group Id to update the group. Referencing non-existing Entity Group Id will cause 'Not Found' error.Remove 'id', 'tenantId' and optionally 'ownerId' from the request body example (below) to create new Entity Group entity. Entity group name is unique in the scope of owner and entity type. For example, you can't create two tenant device groups called 'Water meters'. However, you may create device and asset group with the same name. And also you may create groups with the same name for two different customers of the same tenant. Available for users with 'TENANT_ADMIN' or 'CUSTOMER_USER' authority. Security check is performed to verify that the user has 'WRITE' permission for specified group. # noqa: E501
|
|
3522
|
+
This method makes a synchronous HTTP request by default. To make an
|
|
3523
|
+
asynchronous HTTP request, please pass async_req=True
|
|
3524
|
+
>>> thread = api.save_entity_group_using_post(async_req=True)
|
|
3525
|
+
>>> result = thread.get()
|
|
3526
|
+
|
|
3527
|
+
:param async_req bool
|
|
3528
|
+
:param EntityGroup body:
|
|
3529
|
+
:return: EntityGroupInfo
|
|
3530
|
+
If the method is called asynchronously,
|
|
3531
|
+
returns the request thread.
|
|
3532
|
+
"""
|
|
3533
|
+
kwargs['_return_http_data_only'] = True
|
|
3534
|
+
if kwargs.get('async_req'):
|
|
3535
|
+
return self.save_entity_group_using_post_with_http_info(**kwargs) # noqa: E501
|
|
3536
|
+
else:
|
|
3537
|
+
(data) = self.save_entity_group_using_post_with_http_info(**kwargs) # noqa: E501
|
|
3538
|
+
return data
|
|
3539
|
+
|
|
3540
|
+
def save_entity_group_using_post_with_http_info(self, **kwargs): # noqa: E501
|
|
3541
|
+
"""Create Or Update Entity Group (saveEntityGroup) # noqa: E501
|
|
3542
|
+
|
|
3543
|
+
Create or update the Entity Group. When creating Entity Group, platform generates Entity Group Id as [time-based UUID](https://en.wikipedia.org/wiki/Universally_unique_identifier#Version_1_(date-time_and_MAC_address)). The newly created Entity Group Id will be present in the response. Specify existing Entity Group Id to update the group. Referencing non-existing Entity Group Id will cause 'Not Found' error.Remove 'id', 'tenantId' and optionally 'ownerId' from the request body example (below) to create new Entity Group entity. Entity group name is unique in the scope of owner and entity type. For example, you can't create two tenant device groups called 'Water meters'. However, you may create device and asset group with the same name. And also you may create groups with the same name for two different customers of the same tenant. Available for users with 'TENANT_ADMIN' or 'CUSTOMER_USER' authority. Security check is performed to verify that the user has 'WRITE' permission for specified group. # noqa: E501
|
|
3544
|
+
This method makes a synchronous HTTP request by default. To make an
|
|
3545
|
+
asynchronous HTTP request, please pass async_req=True
|
|
3546
|
+
>>> thread = api.save_entity_group_using_post_with_http_info(async_req=True)
|
|
3547
|
+
>>> result = thread.get()
|
|
3548
|
+
|
|
3549
|
+
:param async_req bool
|
|
3550
|
+
:param EntityGroup body:
|
|
3551
|
+
:return: EntityGroupInfo
|
|
3552
|
+
If the method is called asynchronously,
|
|
3553
|
+
returns the request thread.
|
|
3554
|
+
"""
|
|
3555
|
+
|
|
3556
|
+
all_params = ['body'] # noqa: E501
|
|
3557
|
+
all_params.append('async_req')
|
|
3558
|
+
all_params.append('_return_http_data_only')
|
|
3559
|
+
all_params.append('_preload_content')
|
|
3560
|
+
all_params.append('_request_timeout')
|
|
3561
|
+
|
|
3562
|
+
params = locals()
|
|
3563
|
+
for key, val in six.iteritems(params['kwargs']):
|
|
3564
|
+
if key not in all_params:
|
|
3565
|
+
raise TypeError(
|
|
3566
|
+
"Got an unexpected keyword argument '%s'"
|
|
3567
|
+
" to method save_entity_group_using_post" % key
|
|
3568
|
+
)
|
|
3569
|
+
params[key] = val
|
|
3570
|
+
del params['kwargs']
|
|
3571
|
+
|
|
3572
|
+
collection_formats = {}
|
|
3573
|
+
|
|
3574
|
+
path_params = {}
|
|
3575
|
+
|
|
3576
|
+
query_params = []
|
|
3577
|
+
|
|
3578
|
+
header_params = {}
|
|
3579
|
+
|
|
3580
|
+
form_params = []
|
|
3581
|
+
local_var_files = {}
|
|
3582
|
+
|
|
3583
|
+
body_params = None
|
|
3584
|
+
if 'body' in params:
|
|
3585
|
+
body_params = params['body']
|
|
3586
|
+
# HTTP header `Accept`
|
|
3587
|
+
header_params['Accept'] = self.api_client.select_header_accept(
|
|
3588
|
+
['application/json']) # noqa: E501
|
|
3589
|
+
|
|
3590
|
+
# HTTP header `Content-Type`
|
|
3591
|
+
header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501
|
|
3592
|
+
['application/json']) # noqa: E501
|
|
3593
|
+
|
|
3594
|
+
# Authentication setting
|
|
3595
|
+
auth_settings = ['X-Authorization'] # noqa: E501
|
|
3596
|
+
|
|
3597
|
+
return self.api_client.call_api(
|
|
3598
|
+
'/api/entityGroup', 'POST',
|
|
3599
|
+
path_params,
|
|
3600
|
+
query_params,
|
|
3601
|
+
header_params,
|
|
3602
|
+
body=body_params,
|
|
3603
|
+
post_params=form_params,
|
|
3604
|
+
files=local_var_files,
|
|
3605
|
+
response_type='EntityGroupInfo', # noqa: E501
|
|
3606
|
+
auth_settings=auth_settings,
|
|
3607
|
+
async_req=params.get('async_req'),
|
|
3608
|
+
_return_http_data_only=params.get('_return_http_data_only'),
|
|
3609
|
+
_preload_content=params.get('_preload_content', True),
|
|
3610
|
+
_request_timeout=params.get('_request_timeout'),
|
|
3611
|
+
collection_formats=collection_formats)
|
|
3612
|
+
|
|
3613
|
+
def share_entity_group_to_child_owner_user_group_using_post(self, entity_group_id, user_group_id, role_id, **kwargs): # noqa: E501
|
|
3614
|
+
"""Share the Entity Group with User group (shareEntityGroupToChildOwnerUserGroup) # noqa: E501
|
|
3615
|
+
|
|
3616
|
+
Share the entity group with specified user group using specified role. Available for users with 'TENANT_ADMIN' or 'CUSTOMER_USER' authority. Security check is performed to verify that the user has 'WRITE' permission for specified group. # noqa: E501
|
|
3617
|
+
This method makes a synchronous HTTP request by default. To make an
|
|
3618
|
+
asynchronous HTTP request, please pass async_req=True
|
|
3619
|
+
>>> thread = api.share_entity_group_to_child_owner_user_group_using_post(entity_group_id, user_group_id, role_id, async_req=True)
|
|
3620
|
+
>>> result = thread.get()
|
|
3621
|
+
|
|
3622
|
+
:param async_req bool
|
|
3623
|
+
:param str entity_group_id: A string value representing the Entity Group Id that you would like to share. For example, '784f394c-42b6-435a-983c-b7beff2784f9' (required)
|
|
3624
|
+
:param str user_group_id: A string value representing the Entity(User) Group Id that you would like to share with. For example, '784f394c-42b6-435a-983c-b7beff2784f9' (required)
|
|
3625
|
+
:param str role_id: A string value representing the Role Id that describes set of permissions you would like to share (read, write, etc). For example, '784f394c-42b6-435a-983c-b7beff2784f9' (required)
|
|
3626
|
+
:return: None
|
|
3627
|
+
If the method is called asynchronously,
|
|
3628
|
+
returns the request thread.
|
|
3629
|
+
"""
|
|
3630
|
+
kwargs['_return_http_data_only'] = True
|
|
3631
|
+
if kwargs.get('async_req'):
|
|
3632
|
+
return self.share_entity_group_to_child_owner_user_group_using_post_with_http_info(entity_group_id, user_group_id, role_id, **kwargs) # noqa: E501
|
|
3633
|
+
else:
|
|
3634
|
+
(data) = self.share_entity_group_to_child_owner_user_group_using_post_with_http_info(entity_group_id, user_group_id, role_id, **kwargs) # noqa: E501
|
|
3635
|
+
return data
|
|
3636
|
+
|
|
3637
|
+
def share_entity_group_to_child_owner_user_group_using_post_with_http_info(self, entity_group_id, user_group_id, role_id, **kwargs): # noqa: E501
|
|
3638
|
+
"""Share the Entity Group with User group (shareEntityGroupToChildOwnerUserGroup) # noqa: E501
|
|
3639
|
+
|
|
3640
|
+
Share the entity group with specified user group using specified role. Available for users with 'TENANT_ADMIN' or 'CUSTOMER_USER' authority. Security check is performed to verify that the user has 'WRITE' permission for specified group. # noqa: E501
|
|
3641
|
+
This method makes a synchronous HTTP request by default. To make an
|
|
3642
|
+
asynchronous HTTP request, please pass async_req=True
|
|
3643
|
+
>>> thread = api.share_entity_group_to_child_owner_user_group_using_post_with_http_info(entity_group_id, user_group_id, role_id, async_req=True)
|
|
3644
|
+
>>> result = thread.get()
|
|
3645
|
+
|
|
3646
|
+
:param async_req bool
|
|
3647
|
+
:param str entity_group_id: A string value representing the Entity Group Id that you would like to share. For example, '784f394c-42b6-435a-983c-b7beff2784f9' (required)
|
|
3648
|
+
:param str user_group_id: A string value representing the Entity(User) Group Id that you would like to share with. For example, '784f394c-42b6-435a-983c-b7beff2784f9' (required)
|
|
3649
|
+
:param str role_id: A string value representing the Role Id that describes set of permissions you would like to share (read, write, etc). For example, '784f394c-42b6-435a-983c-b7beff2784f9' (required)
|
|
3650
|
+
:return: None
|
|
3651
|
+
If the method is called asynchronously,
|
|
3652
|
+
returns the request thread.
|
|
3653
|
+
"""
|
|
3654
|
+
|
|
3655
|
+
all_params = ['entity_group_id', 'user_group_id', 'role_id'] # noqa: E501
|
|
3656
|
+
all_params.append('async_req')
|
|
3657
|
+
all_params.append('_return_http_data_only')
|
|
3658
|
+
all_params.append('_preload_content')
|
|
3659
|
+
all_params.append('_request_timeout')
|
|
3660
|
+
|
|
3661
|
+
params = locals()
|
|
3662
|
+
for key, val in six.iteritems(params['kwargs']):
|
|
3663
|
+
if key not in all_params:
|
|
3664
|
+
raise TypeError(
|
|
3665
|
+
"Got an unexpected keyword argument '%s'"
|
|
3666
|
+
" to method share_entity_group_to_child_owner_user_group_using_post" % key
|
|
3667
|
+
)
|
|
3668
|
+
params[key] = val
|
|
3669
|
+
del params['kwargs']
|
|
3670
|
+
# verify the required parameter 'entity_group_id' is set
|
|
3671
|
+
if ('entity_group_id' not in params or
|
|
3672
|
+
params['entity_group_id'] is None):
|
|
3673
|
+
raise ValueError("Missing the required parameter `entity_group_id` when calling `share_entity_group_to_child_owner_user_group_using_post`") # noqa: E501
|
|
3674
|
+
# verify the required parameter 'user_group_id' is set
|
|
3675
|
+
if ('user_group_id' not in params or
|
|
3676
|
+
params['user_group_id'] is None):
|
|
3677
|
+
raise ValueError("Missing the required parameter `user_group_id` when calling `share_entity_group_to_child_owner_user_group_using_post`") # noqa: E501
|
|
3678
|
+
# verify the required parameter 'role_id' is set
|
|
3679
|
+
if ('role_id' not in params or
|
|
3680
|
+
params['role_id'] is None):
|
|
3681
|
+
raise ValueError("Missing the required parameter `role_id` when calling `share_entity_group_to_child_owner_user_group_using_post`") # noqa: E501
|
|
3682
|
+
|
|
3683
|
+
collection_formats = {}
|
|
3684
|
+
|
|
3685
|
+
path_params = {}
|
|
3686
|
+
if 'entity_group_id' in params:
|
|
3687
|
+
path_params['entityGroupId'] = params['entity_group_id'] # noqa: E501
|
|
3688
|
+
if 'user_group_id' in params:
|
|
3689
|
+
path_params['userGroupId'] = params['user_group_id'] # noqa: E501
|
|
3690
|
+
if 'role_id' in params:
|
|
3691
|
+
path_params['roleId'] = params['role_id'] # noqa: E501
|
|
3692
|
+
|
|
3693
|
+
query_params = []
|
|
3694
|
+
|
|
3695
|
+
header_params = {}
|
|
3696
|
+
|
|
3697
|
+
form_params = []
|
|
3698
|
+
local_var_files = {}
|
|
3699
|
+
|
|
3700
|
+
body_params = None
|
|
3701
|
+
# HTTP header `Accept`
|
|
3702
|
+
header_params['Accept'] = self.api_client.select_header_accept(
|
|
3703
|
+
['application/json']) # noqa: E501
|
|
3704
|
+
|
|
3705
|
+
# Authentication setting
|
|
3706
|
+
auth_settings = ['X-Authorization'] # noqa: E501
|
|
3707
|
+
|
|
3708
|
+
return self.api_client.call_api(
|
|
3709
|
+
'/api/entityGroup/{entityGroupId}/{userGroupId}/{roleId}/share', 'POST',
|
|
3710
|
+
path_params,
|
|
3711
|
+
query_params,
|
|
3712
|
+
header_params,
|
|
3713
|
+
body=body_params,
|
|
3714
|
+
post_params=form_params,
|
|
3715
|
+
files=local_var_files,
|
|
3716
|
+
response_type=None, # noqa: E501
|
|
3717
|
+
auth_settings=auth_settings,
|
|
3718
|
+
async_req=params.get('async_req'),
|
|
3719
|
+
_return_http_data_only=params.get('_return_http_data_only'),
|
|
3720
|
+
_preload_content=params.get('_preload_content', True),
|
|
3721
|
+
_request_timeout=params.get('_request_timeout'),
|
|
3722
|
+
collection_formats=collection_formats)
|
|
3723
|
+
|
|
3724
|
+
def share_entity_group_using_post(self, entity_group_id, **kwargs): # noqa: E501
|
|
3725
|
+
"""Share the Entity Group (shareEntityGroup) # noqa: E501
|
|
3726
|
+
|
|
3727
|
+
Share the entity group with certain user group based on the provided Share Group Request. The request is quite flexible and processing of the request involves multiple security checks using platform RBAC feature. Available for users with 'TENANT_ADMIN' or 'CUSTOMER_USER' authority. Security check is performed to verify that the user has 'WRITE' permission for specified group. # noqa: E501
|
|
3728
|
+
This method makes a synchronous HTTP request by default. To make an
|
|
3729
|
+
asynchronous HTTP request, please pass async_req=True
|
|
3730
|
+
>>> thread = api.share_entity_group_using_post(entity_group_id, async_req=True)
|
|
3731
|
+
>>> result = thread.get()
|
|
3732
|
+
|
|
3733
|
+
:param async_req bool
|
|
3734
|
+
:param str entity_group_id: A string value representing the Entity Group Id. For example, '784f394c-42b6-435a-983c-b7beff2784f9' (required)
|
|
3735
|
+
:param ShareGroupRequest body:
|
|
3736
|
+
:return: None
|
|
3737
|
+
If the method is called asynchronously,
|
|
3738
|
+
returns the request thread.
|
|
3739
|
+
"""
|
|
3740
|
+
kwargs['_return_http_data_only'] = True
|
|
3741
|
+
if kwargs.get('async_req'):
|
|
3742
|
+
return self.share_entity_group_using_post_with_http_info(entity_group_id, **kwargs) # noqa: E501
|
|
3743
|
+
else:
|
|
3744
|
+
(data) = self.share_entity_group_using_post_with_http_info(entity_group_id, **kwargs) # noqa: E501
|
|
3745
|
+
return data
|
|
3746
|
+
|
|
3747
|
+
def share_entity_group_using_post_with_http_info(self, entity_group_id, **kwargs): # noqa: E501
|
|
3748
|
+
"""Share the Entity Group (shareEntityGroup) # noqa: E501
|
|
3749
|
+
|
|
3750
|
+
Share the entity group with certain user group based on the provided Share Group Request. The request is quite flexible and processing of the request involves multiple security checks using platform RBAC feature. Available for users with 'TENANT_ADMIN' or 'CUSTOMER_USER' authority. Security check is performed to verify that the user has 'WRITE' permission for specified group. # noqa: E501
|
|
3751
|
+
This method makes a synchronous HTTP request by default. To make an
|
|
3752
|
+
asynchronous HTTP request, please pass async_req=True
|
|
3753
|
+
>>> thread = api.share_entity_group_using_post_with_http_info(entity_group_id, async_req=True)
|
|
3754
|
+
>>> result = thread.get()
|
|
3755
|
+
|
|
3756
|
+
:param async_req bool
|
|
3757
|
+
:param str entity_group_id: A string value representing the Entity Group Id. For example, '784f394c-42b6-435a-983c-b7beff2784f9' (required)
|
|
3758
|
+
:param ShareGroupRequest body:
|
|
3759
|
+
:return: None
|
|
3760
|
+
If the method is called asynchronously,
|
|
3761
|
+
returns the request thread.
|
|
3762
|
+
"""
|
|
3763
|
+
|
|
3764
|
+
all_params = ['entity_group_id', 'body'] # noqa: E501
|
|
3765
|
+
all_params.append('async_req')
|
|
3766
|
+
all_params.append('_return_http_data_only')
|
|
3767
|
+
all_params.append('_preload_content')
|
|
3768
|
+
all_params.append('_request_timeout')
|
|
3769
|
+
|
|
3770
|
+
params = locals()
|
|
3771
|
+
for key, val in six.iteritems(params['kwargs']):
|
|
3772
|
+
if key not in all_params:
|
|
3773
|
+
raise TypeError(
|
|
3774
|
+
"Got an unexpected keyword argument '%s'"
|
|
3775
|
+
" to method share_entity_group_using_post" % key
|
|
3776
|
+
)
|
|
3777
|
+
params[key] = val
|
|
3778
|
+
del params['kwargs']
|
|
3779
|
+
# verify the required parameter 'entity_group_id' is set
|
|
3780
|
+
if ('entity_group_id' not in params or
|
|
3781
|
+
params['entity_group_id'] is None):
|
|
3782
|
+
raise ValueError("Missing the required parameter `entity_group_id` when calling `share_entity_group_using_post`") # noqa: E501
|
|
3783
|
+
|
|
3784
|
+
collection_formats = {}
|
|
3785
|
+
|
|
3786
|
+
path_params = {}
|
|
3787
|
+
if 'entity_group_id' in params:
|
|
3788
|
+
path_params['entityGroupId'] = params['entity_group_id'] # noqa: E501
|
|
3789
|
+
|
|
3790
|
+
query_params = []
|
|
3791
|
+
|
|
3792
|
+
header_params = {}
|
|
3793
|
+
|
|
3794
|
+
form_params = []
|
|
3795
|
+
local_var_files = {}
|
|
3796
|
+
|
|
3797
|
+
body_params = None
|
|
3798
|
+
if 'body' in params:
|
|
3799
|
+
body_params = params['body']
|
|
3800
|
+
# HTTP header `Accept`
|
|
3801
|
+
header_params['Accept'] = self.api_client.select_header_accept(
|
|
3802
|
+
['application/json']) # noqa: E501
|
|
3803
|
+
|
|
3804
|
+
# HTTP header `Content-Type`
|
|
3805
|
+
header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501
|
|
3806
|
+
['application/json']) # noqa: E501
|
|
3807
|
+
|
|
3808
|
+
# Authentication setting
|
|
3809
|
+
auth_settings = ['X-Authorization'] # noqa: E501
|
|
3810
|
+
|
|
3811
|
+
return self.api_client.call_api(
|
|
3812
|
+
'/api/entityGroup/{entityGroupId}/share', 'POST',
|
|
3813
|
+
path_params,
|
|
3814
|
+
query_params,
|
|
3815
|
+
header_params,
|
|
3816
|
+
body=body_params,
|
|
3817
|
+
post_params=form_params,
|
|
3818
|
+
files=local_var_files,
|
|
3819
|
+
response_type=None, # noqa: E501
|
|
3820
|
+
auth_settings=auth_settings,
|
|
3821
|
+
async_req=params.get('async_req'),
|
|
3822
|
+
_return_http_data_only=params.get('_return_http_data_only'),
|
|
3823
|
+
_preload_content=params.get('_preload_content', True),
|
|
3824
|
+
_request_timeout=params.get('_request_timeout'),
|
|
3825
|
+
collection_formats=collection_formats)
|
|
3826
|
+
|
|
3827
|
+
def unassign_entity_group_from_edge_using_delete(self, edge_id, group_type, entity_group_id, **kwargs): # noqa: E501
|
|
3828
|
+
"""Unassign entity group from edge (unassignEntityGroupFromEdge) # noqa: E501
|
|
3829
|
+
|
|
3830
|
+
Clears assignment of the entity group to the edge. Unassignment works in async way - first, 'unassign' notification event pushed to edge queue on platform. Second, remote edge service will receive an 'unassign' command to remove entity group (Edge will receive this instantly, if it's currently connected, or once it's going to be connected to platform). Third, once 'unassign' command will be delivered to edge service, it's going to remove entity group and entities inside this group locally. Available for users with 'TENANT_ADMIN' or 'CUSTOMER_USER' authority. Security check is performed to verify that the user has 'WRITE' permission for the entity (entities). # noqa: E501
|
|
3831
|
+
This method makes a synchronous HTTP request by default. To make an
|
|
3832
|
+
asynchronous HTTP request, please pass async_req=True
|
|
3833
|
+
>>> thread = api.unassign_entity_group_from_edge_using_delete(edge_id, group_type, entity_group_id, async_req=True)
|
|
3834
|
+
>>> result = thread.get()
|
|
3835
|
+
|
|
3836
|
+
:param async_req bool
|
|
3837
|
+
:param str edge_id: A string value representing the edge id. For example, '784f394c-42b6-435a-983c-b7beff2784f9' (required)
|
|
3838
|
+
:param str group_type: EntityGroup type (required)
|
|
3839
|
+
:param str entity_group_id: A string value representing the Entity Group Id. For example, '784f394c-42b6-435a-983c-b7beff2784f9' (required)
|
|
3840
|
+
:return: EntityGroup
|
|
3841
|
+
If the method is called asynchronously,
|
|
3842
|
+
returns the request thread.
|
|
3843
|
+
"""
|
|
3844
|
+
kwargs['_return_http_data_only'] = True
|
|
3845
|
+
if kwargs.get('async_req'):
|
|
3846
|
+
return self.unassign_entity_group_from_edge_using_delete_with_http_info(edge_id, group_type, entity_group_id, **kwargs) # noqa: E501
|
|
3847
|
+
else:
|
|
3848
|
+
(data) = self.unassign_entity_group_from_edge_using_delete_with_http_info(edge_id, group_type, entity_group_id, **kwargs) # noqa: E501
|
|
3849
|
+
return data
|
|
3850
|
+
|
|
3851
|
+
def unassign_entity_group_from_edge_using_delete_with_http_info(self, edge_id, group_type, entity_group_id, **kwargs): # noqa: E501
|
|
3852
|
+
"""Unassign entity group from edge (unassignEntityGroupFromEdge) # noqa: E501
|
|
3853
|
+
|
|
3854
|
+
Clears assignment of the entity group to the edge. Unassignment works in async way - first, 'unassign' notification event pushed to edge queue on platform. Second, remote edge service will receive an 'unassign' command to remove entity group (Edge will receive this instantly, if it's currently connected, or once it's going to be connected to platform). Third, once 'unassign' command will be delivered to edge service, it's going to remove entity group and entities inside this group locally. Available for users with 'TENANT_ADMIN' or 'CUSTOMER_USER' authority. Security check is performed to verify that the user has 'WRITE' permission for the entity (entities). # noqa: E501
|
|
3855
|
+
This method makes a synchronous HTTP request by default. To make an
|
|
3856
|
+
asynchronous HTTP request, please pass async_req=True
|
|
3857
|
+
>>> thread = api.unassign_entity_group_from_edge_using_delete_with_http_info(edge_id, group_type, entity_group_id, async_req=True)
|
|
3858
|
+
>>> result = thread.get()
|
|
3859
|
+
|
|
3860
|
+
:param async_req bool
|
|
3861
|
+
:param str edge_id: A string value representing the edge id. For example, '784f394c-42b6-435a-983c-b7beff2784f9' (required)
|
|
3862
|
+
:param str group_type: EntityGroup type (required)
|
|
3863
|
+
:param str entity_group_id: A string value representing the Entity Group Id. For example, '784f394c-42b6-435a-983c-b7beff2784f9' (required)
|
|
3864
|
+
:return: EntityGroup
|
|
3865
|
+
If the method is called asynchronously,
|
|
3866
|
+
returns the request thread.
|
|
3867
|
+
"""
|
|
3868
|
+
|
|
3869
|
+
all_params = ['edge_id', 'group_type', 'entity_group_id'] # noqa: E501
|
|
3870
|
+
all_params.append('async_req')
|
|
3871
|
+
all_params.append('_return_http_data_only')
|
|
3872
|
+
all_params.append('_preload_content')
|
|
3873
|
+
all_params.append('_request_timeout')
|
|
3874
|
+
|
|
3875
|
+
params = locals()
|
|
3876
|
+
for key, val in six.iteritems(params['kwargs']):
|
|
3877
|
+
if key not in all_params:
|
|
3878
|
+
raise TypeError(
|
|
3879
|
+
"Got an unexpected keyword argument '%s'"
|
|
3880
|
+
" to method unassign_entity_group_from_edge_using_delete" % key
|
|
3881
|
+
)
|
|
3882
|
+
params[key] = val
|
|
3883
|
+
del params['kwargs']
|
|
3884
|
+
# verify the required parameter 'edge_id' is set
|
|
3885
|
+
if ('edge_id' not in params or
|
|
3886
|
+
params['edge_id'] is None):
|
|
3887
|
+
raise ValueError("Missing the required parameter `edge_id` when calling `unassign_entity_group_from_edge_using_delete`") # noqa: E501
|
|
3888
|
+
# verify the required parameter 'group_type' is set
|
|
3889
|
+
if ('group_type' not in params or
|
|
3890
|
+
params['group_type'] is None):
|
|
3891
|
+
raise ValueError("Missing the required parameter `group_type` when calling `unassign_entity_group_from_edge_using_delete`") # noqa: E501
|
|
3892
|
+
# verify the required parameter 'entity_group_id' is set
|
|
3893
|
+
if ('entity_group_id' not in params or
|
|
3894
|
+
params['entity_group_id'] is None):
|
|
3895
|
+
raise ValueError("Missing the required parameter `entity_group_id` when calling `unassign_entity_group_from_edge_using_delete`") # noqa: E501
|
|
3896
|
+
|
|
3897
|
+
collection_formats = {}
|
|
3898
|
+
|
|
3899
|
+
path_params = {}
|
|
3900
|
+
if 'edge_id' in params:
|
|
3901
|
+
path_params['edgeId'] = params['edge_id'] # noqa: E501
|
|
3902
|
+
if 'group_type' in params:
|
|
3903
|
+
path_params['groupType'] = params['group_type'] # noqa: E501
|
|
3904
|
+
if 'entity_group_id' in params:
|
|
3905
|
+
path_params['entityGroupId'] = params['entity_group_id'] # noqa: E501
|
|
3906
|
+
|
|
3907
|
+
query_params = []
|
|
3908
|
+
|
|
3909
|
+
header_params = {}
|
|
3910
|
+
|
|
3911
|
+
form_params = []
|
|
3912
|
+
local_var_files = {}
|
|
3913
|
+
|
|
3914
|
+
body_params = None
|
|
3915
|
+
# HTTP header `Accept`
|
|
3916
|
+
header_params['Accept'] = self.api_client.select_header_accept(
|
|
3917
|
+
['application/json']) # noqa: E501
|
|
3918
|
+
|
|
3919
|
+
# Authentication setting
|
|
3920
|
+
auth_settings = ['X-Authorization'] # noqa: E501
|
|
3921
|
+
|
|
3922
|
+
return self.api_client.call_api(
|
|
3923
|
+
'/api/edge/{edgeId}/entityGroup/{entityGroupId}/{groupType}', 'DELETE',
|
|
3924
|
+
path_params,
|
|
3925
|
+
query_params,
|
|
3926
|
+
header_params,
|
|
3927
|
+
body=body_params,
|
|
3928
|
+
post_params=form_params,
|
|
3929
|
+
files=local_var_files,
|
|
3930
|
+
response_type='EntityGroup', # noqa: E501
|
|
3931
|
+
auth_settings=auth_settings,
|
|
3932
|
+
async_req=params.get('async_req'),
|
|
3933
|
+
_return_http_data_only=params.get('_return_http_data_only'),
|
|
3934
|
+
_preload_content=params.get('_preload_content', True),
|
|
3935
|
+
_request_timeout=params.get('_request_timeout'),
|
|
3936
|
+
collection_formats=collection_formats)
|